@sisense/sdk-data 0.16.0 → 1.1.0

package/dist/dimensional-model/analytics/factory.d.ts

@@ -0,0 +1,47 @@
+import type { Attribute, Measure } from '../interfaces.js';
+/** @internal */
+export declare const BOX_WHISKER: {
+    BOX_MIN_VALUE_NAME: string;
+    BOX_MEDIAN_VALUE_NAME: string;
+    BOX_MAX_VALUE_NAME: string;
+    WHISKER_MIN_VALUE_NAME: string;
+    WHISKER_MAX_VALUE_NAME: string;
+    OUTLIER_COUNT_VALUE_NAME: string;
+    OUTLIER_MIN_VALUE_NAME: string;
+    OUTLIER_MAX_VALUE_NAME: string;
+};
+/**
+ * Returns an array of values for box whisker plot using interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing IQR values for box whisker plots.
+ */
+export declare function boxWhiskerIqrValues(target: Attribute): Measure[];
+/**
+ * Returns an array of extremum values for box whisker plot.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing extremum values for box whisker plots.
+ */
+export declare function boxWhiskerExtremumsValues(target: Attribute): Measure[];
+/**
+ * Returns an array of values for box whisker plot using standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing standard deviation values for box whisker plots.
+ */
+export declare function boxWhiskerStdDevValues(target: Attribute): Measure[];
+/**
+ * Returns an attribute representing outlier points based on interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using IQR.
+ */
+export declare const boxWhiskerIqrOutliers: (target: Attribute) => Attribute;
+/**
+ * Returns an attribute representing outlier points based on standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using standard deviation.
+ */
+export declare const boxWhiskerStdDevOutliers: (target: Attribute) => Attribute;

package/dist/dimensional-model/analytics/factory.js

@@ -0,0 +1,140 @@
+import cloneDeep from 'lodash/cloneDeep.js';
+import { customFormula } from '../measures/factory.js';
+/** @internal */
+export const BOX_WHISKER = {
+    BOX_MIN_VALUE_NAME: 'Box Min',
+    BOX_MEDIAN_VALUE_NAME: 'Box Median',
+    BOX_MAX_VALUE_NAME: 'Box Max',
+    WHISKER_MIN_VALUE_NAME: 'Whisker Min',
+    WHISKER_MAX_VALUE_NAME: 'Whisker Max',
+    OUTLIER_COUNT_VALUE_NAME: 'Outlier Count',
+    OUTLIER_MIN_VALUE_NAME: 'Outlier Min',
+    OUTLIER_MAX_VALUE_NAME: 'Outlier Max',
+};
+function boxWhiskerCommonValues(target) {
+    return [
+        customFormula(BOX_WHISKER.BOX_MIN_VALUE_NAME, 'QUARTILE([Attr], 1)', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.BOX_MEDIAN_VALUE_NAME, 'MEDIAN([Attr])', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.BOX_MAX_VALUE_NAME, 'QUARTILE([Attr], 3)', {
+            Attr: target,
+        }),
+    ];
+}
+/**
+ * Returns an array of values for box whisker plot using interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing IQR values for box whisker plots.
+ */
+export function boxWhiskerIqrValues(target) {
+    return [
+        ...boxWhiskerCommonValues(target),
+        customFormula(BOX_WHISKER.WHISKER_MIN_VALUE_NAME, 'LOWERWHISKERMAX_IQR([Attr])', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.WHISKER_MAX_VALUE_NAME, 'UPPERWHISKERMIN_IQR([Attr])', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.OUTLIER_COUNT_VALUE_NAME, 'OUTLIERSCOUNT_IQR([Attr])', {
+            Attr: target,
+        }),
+    ];
+}
+/**
+ * Returns an array of extremum values for box whisker plot.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing extremum values for box whisker plots.
+ */
+export function boxWhiskerExtremumsValues(target) {
+    return [
+        ...boxWhiskerCommonValues(target),
+        customFormula(BOX_WHISKER.WHISKER_MIN_VALUE_NAME, 'MIN([Attr])', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.WHISKER_MAX_VALUE_NAME, 'MAX([Attr])', {
+            Attr: target,
+        }),
+    ];
+}
+/**
+ * Returns an array of values for box whisker plot using standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Measure[]} An array of measures representing standard deviation values for box whisker plots.
+ */
+export function boxWhiskerStdDevValues(target) {
+    return [
+        ...boxWhiskerCommonValues(target),
+        customFormula(BOX_WHISKER.WHISKER_MIN_VALUE_NAME, 'LOWERWHISKERMAX_STDEVP([Attr])', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.WHISKER_MAX_VALUE_NAME, 'UPPERWHISKERMIN_STDEVP([Attr])', {
+            Attr: target,
+        }),
+        customFormula(BOX_WHISKER.OUTLIER_COUNT_VALUE_NAME, 'OUTLIERSCOUNT_STDEVP([Attr])', {
+            Attr: target,
+        }),
+    ];
+}
+/**
+ * Returns an attribute representing outlier points based on interquartile range (IQR) calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using IQR.
+ */
+export const boxWhiskerIqrOutliers = (target) => {
+    const outliersAttrWithInnerFilter = cloneDeep(target);
+    const outliersMax = customFormula(BOX_WHISKER.OUTLIER_MAX_VALUE_NAME, '(UPPERWHISKERMIN_IQR([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    const outliersMin = customFormula(BOX_WHISKER.OUTLIER_MIN_VALUE_NAME, '(LOWERWHISKERMAX_IQR([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    outliersAttrWithInnerFilter.name = `${outliersAttrWithInnerFilter.name} (Outliers)`;
+    outliersAttrWithInnerFilter.jaql = () => {
+        return Object.assign(Object.assign({}, target.jaql()), { filter: {
+                or: [
+                    {
+                        fromNotEqual: outliersMax.jaql(true),
+                    },
+                    {
+                        toNotEqual: outliersMin.jaql(true),
+                    },
+                ],
+            } });
+    };
+    return outliersAttrWithInnerFilter;
+};
+/**
+ * Returns an attribute representing outlier points based on standard deviation calculations.
+ *
+ * @param {Attribute} target - The target attribute for calculations.
+ * @returns {Attribute} An attribute representing outliers for box whisker plots using standard deviation.
+ */
+export const boxWhiskerStdDevOutliers = (target) => {
+    const outliersAttrWithInnerFilter = cloneDeep(target);
+    const outliersMax = customFormula(BOX_WHISKER.OUTLIER_MAX_VALUE_NAME, '(UPPERWHISKERMIN_STDEVP([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    const outliersMin = customFormula(BOX_WHISKER.OUTLIER_MIN_VALUE_NAME, '(LOWERWHISKERMAX_STDEVP([Attr]), all([Attr]))', {
+        Attr: target,
+    });
+    outliersAttrWithInnerFilter.jaql = () => {
+        return Object.assign(Object.assign({}, target.jaql()), { filter: {
+                or: [
+                    {
+                        fromNotEqual: outliersMax.jaql(true),
+                    },
+                    {
+                        toNotEqual: outliersMin.jaql(true),
+                    },
+                ],
+            } });
+    };
+    return outliersAttrWithInnerFilter;
+};

package/dist/dimensional-model/factory.js

@@ -46,5 +46,5 @@ export function create(item) {
         item.dimtype) {
         return createDimension(item);
     }
-    throw new TranslatableError('errors.unsupportedDimesionalElement');
+    throw new TranslatableError('errors.unsupportedDimensionalElement');
 }