@sisense/sdk-data 0.11.3

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

@@ -0,0 +1,437 @@
+import { Attribute, Measure, Filter, CalculatedMeasure, BaseMeasure } from '../interfaces.js';
+import { ForecastFormulaOptions, TrendFormulaOptions } from '../../interfaces.js';
+/**
+ * Defines the different numeric operators that can be used with numeric filters
+ *
+ * @internal
+ */
+export declare const RankingTypes: {
+    /**
+     * In competition ranking, items that compare equal receive the same ranking number, and then a gap is left in the ranking numbers.
+     */
+    StandardCompetition: string;
+    /**
+     * Sometimes, competition ranking is done by leaving the gaps in the ranking numbers before the sets of equal-ranking items (rather than after them as in standard competition ranking)
+     */
+    ModifiedCompetition: string;
+    /**
+     * In dense ranking, items that compare equally receive the same ranking number, and the next items receive the immediately following ranking number.
+     */
+    Dense: string;
+    /**
+     * In ordinal ranking, all items receive distinct ordinal numbers, including items that compare equal. The assignment of distinct ordinal numbers is arbitrarily.
+     */
+    Ordinal: string;
+};
+/**
+ * Defines the different ranking sorting types supported by rank measure
+ *
+ * @internal
+ */
+export declare const RankingSortTypes: {
+    Ascending: string;
+    Descending: string;
+};
+/**
+ * Creates a basic aggregated measure.
+ * This is a base function to build other aggregation functions (e.g., `sum`, `average`, etc)
+ * as listed in {@link AggregationTypes}.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param aggregationType - Aggregation type. See {@link AggregationTypes}
+ * @param name - Optional name for the new measure
+ * @param format - Numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function aggregate(attribute: Attribute, aggregationType: string, name?: string, format?: string): BaseMeasure;
+/**
+ * Returns a numeric value as a measure.
+ *
+ * @param value - Value to be returned as a measure
+ * @returns A Calculated Measure instance
+ */
+export declare function constant(value: number): CalculatedMeasure;
+/**
+ * Creates a sum aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function sum(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates an average aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function average(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates a min aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function min(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates a max aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function max(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates a median aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function median(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates a count aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function count(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates a count distinct aggregation over the given attribute.
+ *
+ * @param attribute - Attribute to aggregate
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Measure instance
+ */
+export declare function countDistinct(attribute: Attribute, name?: string, format?: string): BaseMeasure;
+/**
+ * Creates a measured value with the given measure and set of filters.
+ *
+ * @param measure - Measure to filter
+ * @param filters - Filters to apply to the measure
+ * @param name - Optional name for the new measure
+ * @param format - Optional numeric formatting to apply
+ * @returns A Calculated Measure instance
+ */
+export declare function measuredValue(measure: Measure, filters: Filter[], name?: string, format?: string): CalculatedMeasure;
+/**
+ * Adds the two given values.
+ *
+ * @param value1 - First value
+ * @param value2 - Second value
+ * @param name - Optional name for the new measure
+ * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
+ * @returns A Calculated Measure instance
+ */
+export declare function add(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+/**
+ * Subtract value2 from value1.
+ *
+ * @param value1 - First value
+ * @param value2 - Second value
+ * @param name - Optional name for the new measure
+ * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
+ * @returns A Calculated Measure instance
+ */
+export declare function subtract(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+/**
+ * Multiply value1 with value2.
+ *
+ * @param value1 - First value
+ * @param value2 - Second value
+ * @param name - Optional name for the new measure
+ * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
+ * @returns A Calculated Measure instance
+ */
+export declare function multiply(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+/**
+ * Divide value1 by value2.
+ *
+ * @param value1 - First value
+ * @param value2 - Second value
+ * @param name - Optional name for the new measure
+ * @param withParentheses - Optional boolean flag whether to wrap the arithmetic operation with parentheses
+ * @returns A Calculated Measure instance
+ */
+export declare function divide(value1: Measure | number, value2: Measure | number, name?: string, withParentheses?: boolean): CalculatedMeasure;
+/**
+ * Calculates year to date (YTD) sum of the given measure. Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply the YTD Sum to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function yearToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates quarter to date (QTD) sum of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply the QTD Sum to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function quarterToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates month to date (MTD) sum of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply the MTD Sum to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function monthToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates week to date (WTD) sum of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply the WTD Sum to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function weekToDateSum(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Returns the running total of the measure by the defined dimension
+ * according to the current sorting order in the query.
+ *
+ * By default, `RSUM` accumulates a measure by the sorting order of the dimension.
+ * To accumulate by another order, the relevant measure should be added as an additional column and sorted.
+ *
+ * Note: Filtering the `RSUM` column by Values,
+ * filters the dimensions and recalculates the `RSUM` from the first filtered value.
+ *
+ * @param measure - Measure to apply the Running Sum to
+ * @param _continuous - Boolean flag whether to accumulate the sum continuously
+ * when there are two or more dimensions. The default value is False.
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function runningSum(measure: Measure, _continuous?: boolean, name?: string): CalculatedMeasure;
+/**
+ * Calculates growth over time. The time dimension to be used is determined by the time resolution in the query.
+ *
+ * Formula: `(current value – compared value) / compared value`.
+ *
+ * @example
+ *
+ * If this month your value is 12, and last month it was 10, your Growth for this month is 20% (0.2).
+ *
+ * Calculation: `(12 – 10) / 10 = 0.2`
+ *
+ * If this year your value is 80, and last year it was 100, your Growth for this year is -20% ( -0.2).
+ *
+ * Calculation: `(80 – 100) / 100 = -0.2`
+ * @param measure - Measure to apply growth to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function growth(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates growth rate over time. The time dimension to be used is determined by the time resolution in the query.
+ *
+ * @example
+ * If this month your value is 12, and last month it was 10, your Growth Rate for this month is 12/10 = 120% (1.2).
+ *
+ * Calculation: `12 / 10 = 1.2`
+ *
+ * If this year your value is 80, and last year it was 100, your Growth for this year is 80/100 = 80% ( 0.8).
+ *
+ * Calculation: `80 / 100 = 0.8`
+ * @param measure - Measure to apply the Growth rate
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function growthRate(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the growth from past week of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply growth to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function growthPastWeek(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the growth from past month of the given measure.
+ * Date dimension will be dynamically taken from the query
+ *
+ * @param measure - Measure to apply growth to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function growthPastMonth(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the growth from past quarter of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply growth to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function growthPastQuarter(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the growth from past year of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply growth to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function growthPastYear(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the difference of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - measure to apply difference to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function difference(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the difference from past week of the given measure.
+ * Ddate dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply difference to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function diffPastWeek(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the difference from past month of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply difference to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function diffPastMonth(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the difference from past quarter of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply difference to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function diffPastQuarter(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the difference from past year of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply difference to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function diffPastYear(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the value of the past day of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply past value to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function pastDay(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the value of the past week of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply past value to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function pastWeek(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the value of the path month of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply past value to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function pastMonth(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the value of the past quarter of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply past value to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function pastQuarter(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates the value of the past year of the given measure.
+ * Date dimension will be dynamically taken from the query.
+ *
+ * @param measure - Measure to apply past value to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function pastYear(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Calculates contribution.
+ *
+ * @param measure - Measure to apply the Contribution logic to
+ * @param name - Name for the new measure
+ * @returns A Calculated Measure instance
+ */
+export declare function contribution(measure: Measure, name?: string): CalculatedMeasure;
+/**
+ * Fits a specified trend type to your measure. The trend types include linear,
+ * logarithmic, advanced smoothing, and local estimates. It allows for an optional
+ * feature to automatically identify and ignore anomalous values in the series.
+ *
+ * Trend requires a Sisense instance version of L2023.6.0 or greater.
+ *
+ * @param measure - Measure to apply the trend logic to
+ * @param name - Name for the new measure
+ * @param options - Trend options
+ * @returns A Calculated Measure instance
+ */
+export declare function trend(measure: Measure, name?: string, options?: TrendFormulaOptions): CalculatedMeasure;
+/**
+ * Calculates Forecast leveraging advanced autoML techniques to generate
+ * a forecast for a given measure.
+ *
+ * This function offers flexibility with auto-selection of the best
+ * statistical model or user-selected models, and it also provides control
+ * over the time period used for training the model, as well as options to
+ * improve forecast accuracy by supplying expected lower and upper limits.
+ *
+ * In addition to forecast, upper and lower confidence interval is returned
+ * with the name of the new measure and a suffix of _upper and _lower
+ * respectively.
+ *
+ * Forecast requires a Sisense instance version of L2023.6.0 or greater.
+ *
+ * @param measure - Measure to apply the forecast logic to
+ * @param name - Name for the new measure
+ * @param options - Forecast options
+ * @returns A Calculated Measure instance
+ */
+export declare function forecast(measure: Measure, name?: string, options?: ForecastFormulaOptions): CalculatedMeasure;
+/**
+ * Calculates the rank of a value in a list of values.
+ *
+ * @example
+ * `RANK(Total Cost, “ASC”, “1224”, Product, Years)`
+ * will return the rank of the total annual cost per each product were sorted in ascending order.
+ * @param measure - Measure to apply the Contribution logic to
+ * @param name - Name for the new measure
+ * @param sort - By default sort order is descending.
+ * @param rankType - By default the type is standard competition ranking `(“1224” ranking)`.
+ * Supports also modified competition ranking `(“1334” ranking)`, dense ranking `(“1223” ranking)`,
+ * and ordinal ranking `(“1234” ranking)`.
+ * @param groupBy - Rank partitions attributes
+ * @returns A rank measure
+ */
+export declare function rank(measure: Measure, name?: string, sort?: string, rankType?: string, groupBy?: Attribute[]): CalculatedMeasure;