@sme.up/ketchup 9.2.0 → 9.4.0

package/dist/types/managers/kup-manager/kup-manager.d.ts

@@ -20,73 +20,73 @@ import { Options } from 'html2canvas';
  * @module KupManager
  */
 export declare class KupManager {
-  data: KupData;
-  dates: KupDates;
-  debug: KupDebug;
-  dynamicPosition: KupDynamicPosition;
-  interact: KupInteract;
-  language: KupLanguage;
-  magicBox: HTMLKupMagicBoxElement;
-  math: KupMath;
-  objects: KupObjects;
-  overrides?: KupManagerInitialization;
-  resize: ResizeObserver;
-  scrollOnHover: KupScrollOnHover;
-  search: KupSearch;
-  utilities: KupManagerUtilities;
-  theme: KupTheme;
-  toolbar: KupToolbar;
-  tooltip: KupTooltip;
-  /**
-   * Initializes KupManager.
-   */
-  constructor(overrides?: KupManagerInitialization);
-  /**
-   * Creates kup-magic-box component.
-   */
-  showMagicBox(): void;
-  /**
-   * Removes kup-magic-box component.
-   */
-  hideMagicBox(): void;
-  /**
-   * Creates or removes kup-magic-box component depending on its existence.
-   */
-  toggleMagicBox(): void;
-  /**
-   * Sets both locale and language library-wide.
-   * @param {KupDatesLocales} locale - The supported locale.
-   */
-  setLibraryLocalization(locale: KupDatesLocales): void;
-  /**
-   * Adds a new click callback.
-   * @param {KupManagerClickCb} cb - The callback to add.
-   * @param {boolean} async - When true, the callback will be added asynchrounously to prevent instant firing if it was added through a click event.
-   */
-  addClickCallback(cb: KupManagerClickCb, async?: boolean): void;
-  /**
-   * Retrives event path from event.target
-   * @param currentEl event.target
-   * @param rootElement rootElement of component
-   * @returns
-   */
-  getEventPath(currentEl: unknown, rootElement: HTMLElement): HTMLElement[];
-  /**
-   * Rasterizes an HTMLElement, transforming into a canvas.
-   * @param {HTMLElement} el - Element to rasterize.
-   * @returns {HTMLCanvasElement} - Canvas created from the HTMLElement.
-   *
-   * CSS Mask is not supported:
-   * @see https://github.com/niklasvh/html2canvas/issues/2814
-   * Warning in console about sourcemap, claimed to be solved here but...:
-   * @see https://github.com/niklasvh/html2canvas/pull/2787/files
-   */
-  rasterize(el: HTMLElement, options?: Partial<Options>): Promise<HTMLCanvasElement>;
-  /**
-   * Removes the given click callback.
-   * @param {KupManagerClickCb} cb - The callback to remove.
-   */
-  removeClickCallback(cb: KupManagerClickCb): void;
+    data: KupData;
+    dates: KupDates;
+    debug: KupDebug;
+    dynamicPosition: KupDynamicPosition;
+    interact: KupInteract;
+    language: KupLanguage;
+    magicBox: HTMLKupMagicBoxElement;
+    math: KupMath;
+    objects: KupObjects;
+    overrides?: KupManagerInitialization;
+    resize: ResizeObserver;
+    scrollOnHover: KupScrollOnHover;
+    search: KupSearch;
+    utilities: KupManagerUtilities;
+    theme: KupTheme;
+    toolbar: KupToolbar;
+    tooltip: KupTooltip;
+    /**
+     * Initializes KupManager.
+     */
+    constructor(overrides?: KupManagerInitialization);
+    /**
+     * Creates kup-magic-box component.
+     */
+    showMagicBox(): void;
+    /**
+     * Removes kup-magic-box component.
+     */
+    hideMagicBox(): void;
+    /**
+     * Creates or removes kup-magic-box component depending on its existence.
+     */
+    toggleMagicBox(): void;
+    /**
+     * Sets both locale and language library-wide.
+     * @param {KupDatesLocales} locale - The supported locale.
+     */
+    setLibraryLocalization(locale: KupDatesLocales): void;
+    /**
+     * Adds a new click callback.
+     * @param {KupManagerClickCb} cb - The callback to add.
+     * @param {boolean} async - When true, the callback will be added asynchrounously to prevent instant firing if it was added through a click event.
+     */
+    addClickCallback(cb: KupManagerClickCb, async?: boolean): void;
+    /**
+     * Retrives event path from event.target
+     * @param currentEl event.target
+     * @param rootElement rootElement of component
+     * @returns
+     */
+    getEventPath(currentEl: unknown, rootElement: HTMLElement): HTMLElement[];
+    /**
+     * Rasterizes an HTMLElement, transforming into a canvas.
+     * @param {HTMLElement} el - Element to rasterize.
+     * @returns {HTMLCanvasElement} - Canvas created from the HTMLElement.
+     *
+     * CSS Mask is not supported:
+     * @see https://github.com/niklasvh/html2canvas/issues/2814
+     * Warning in console about sourcemap, claimed to be solved here but...:
+     * @see https://github.com/niklasvh/html2canvas/pull/2787/files
+     */
+    rasterize(el: HTMLElement, options?: Partial<Options>): Promise<HTMLCanvasElement>;
+    /**
+     * Removes the given click callback.
+     * @param {KupManagerClickCb} cb - The callback to remove.
+     */
+    removeClickCallback(cb: KupManagerClickCb): void;
 }
 /**
  * Called by the Ketchup components to retrieve the instance of KupManager (or creating a new one when missing).

package/dist/types/managers/kup-math/kup-math-declarations.d.ts

@@ -2,32 +2,32 @@
  * Interface related to the formulas factory function.
  */
 export interface KupMathFormulas {
-  custom: (formula: string, row: {
-    [index: string]: number;
-  }) => number;
-  normalDistribution: (average: number, variance: number, x: number) => number;
+    custom: (formula: string, row: {
+        [index: string]: number;
+    }) => number;
+    normalDistribution: (average: number, variance: number, x: number) => number;
 }
 /**
  * Locales available for KupMath.
  */
 export declare enum KupMathLocales {
-  cn = "chs",
-  en = "en",
-  es = "es",
-  it = "it",
-  fr = "fr",
-  pl = "pl",
-  ru = "ru"
+    cn = "chs",
+    en = "en",
+    es = "es",
+    it = "it",
+    fr = "fr",
+    pl = "pl",
+    ru = "ru"
 }
 /**
  * Interface related to the numbers factory function.
  */
 export interface KupMathNumbers {
-  toLocaleString: (value: string) => string;
+    toLocaleString: (value: string) => string;
 }
 export interface NumericFieldFormatOptions {
-  integer: number;
-  decimal: number;
-  allowNegative: boolean;
-  group: boolean;
+    integer: number;
+    decimal: number;
+    allowNegative: boolean;
+    group: boolean;
 }

package/dist/types/managers/kup-math/kup-math-helper.d.ts

@@ -5,7 +5,7 @@
  * @returns {number} Result of the formula.
  */
 export declare function customFormula(formula: string, row: {
-  [index: string]: number;
+    [index: string]: number;
 }): number;
 /**
  * Calculates a single Y point of a normal distribution.

package/dist/types/managers/kup-math/kup-math.d.ts

@@ -12,136 +12,136 @@ import { KupMathFormulas, KupMathLocales, KupMathNumbers, NumericFieldFormatOpti
  * @module KupMath
  */
 export declare class KupMath {
-  formulas: KupMathFormulas;
-  locale: KupMathLocales;
-  managedComponents: Set<KupComponent>;
-  numbers: KupMathNumbers;
-  numeral: typeof numeral;
-  /**
-   * Initializes KupMath.
-   */
-  constructor(locale?: KupMathLocales);
-  /**
-   * Sets the locale of the numeral instance. The locales available must be tied to the KupDates locales.
-   * @param {KupMathLocales} locale - Numeraljs locale string.
-   */
-  setLocale(locale: KupMathLocales): void;
-  /**
-   * Calculates the normal distribution on a set of values.
-   * @param {string[] | number[] | String[]} values - Array of values.
-   * @param {number} precision - Number of iterations to run (points). When not specified, defaults to 201.
-   * @returns {number[][]} Returns an array of arrays containing numbers, which are the representation of the calculated normal distribution.
-   */
-  normalDistribution(values: string[] | number[] | String[], precision?: number): number[][];
-  /**
-   * Formats the input number with the specified format of the currently set locale.
-   * @param {string | String | number} input - Input number which will be automatically "numberified".
-   * @param {string} format - Desired format. Defaults to '0,0.00' (i.e.: 2,000,000.51).
-   * @param {boolean} inputIsLocalized Numberifies assuming the input string is in the current KupMath locale's format.
-   * @returns {string} Formatted number.
-   */
-  format(input: string | String | number, format?: string, inputIsLocalized?: boolean): string;
-  /**
-   * Create the pattern string for format a number
-   * @param {boolean} thousandPoint - show thousandPoint
-   * @param {number} decimals - number of decimals
-   * @returns {string} - formatter pattern
-   */
-  createFormatPattern(thousandPoint?: boolean, decimals?: number): string;
-  /**
-   * Returns the decimal separator of current browser
-   * @returns {string} current decimal separator, by locale
-   */
-  decimalSeparator(): string;
-  /**
-   * Returns the group separator of current browser
-   * @returns {string} current group separator, by locale
-   */
-  groupSeparator(): string;
-  /**
-   * Checks if an input string matches options, for desired formatted decimal number (integer digits, decimal digits)
-   * @param {string} value the input value to check
-   * @param {NumericFieldFormatOptions} options options for customize the check
-   * @returns {RegExpMatchArray} an object from applying the regular expression for check
-   */
-  matchNumericValueWithOptions(value: string, options: NumericFieldFormatOptions): RegExpMatchArray;
-  /**
-   * Returns a number from a non-specified input type between string, number, or String.
-   * @param {string | String | number} input - Input value to numberify.
-   * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
-   * @param {string} type - type of number for calculate suffix
-   * @param {string} decFmt - decimal format for the input value.
-   * @returns {number} Resulting number or NaN (when not a number).
-   */
-  numberify(input: string | String | number, inputIsLocalized?: boolean, type?: string, decFmt?: string): number;
-  /**
-   * Returns a number from a non-specified input type between string, number, or String.
-   * If value in is null, undefined or blank, returns 0
-   * @param {string} input number as string, formatted by locale US, decimal separator . (like java decimal numbers)
-   * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
-   * @param {string} type - type of number for calculate suffix
-   * @returns {number} Resulting number
-   **/
-  numberifySafe(input: string, inputIsLocalized?: boolean, type?: string, decFmt?: string): number;
-  /**
-   * Checks if input is a valid number
-   * @param {any} value input value to check
-   * @returns {boolean} if input value is valid number
-   */
-  isNumber(value: any): boolean;
-  /**
-   * Checks if string in input is a valid formatted number
-   * @param {string} value number as string, formatted by actual browser locale
-   * @param {string} type - type of number for calculate suffix
-   * @returns {boolean} true if number string in input is a valid number
-   */
-  isStringNumber(value: string, type: string): boolean;
-  /**
-   * Gets number as string, formatted by locale US, decimal separator . (like java decimal numbers)
-   * @param {string} input number as string, formatted by actual browser locale (maybe)
-   * @param {string} type - type of number for calculate suffix
-   * @param {string} decSeparator - decimal serparator of input string
-   * @returns {string} number as string, formatted by locale US, decimal separator . (like java decimal numbers), without group separator
-   **/
-  formattedStringToNumberString(input: string, type: string, decSeparator?: string): string;
-  /**
-   * Gets the number of decimals for current number
-   * @param {number} value numer input
-   * @returns {number} the number of decimals
-   */
-  countDecimals(value: number): number;
-  /**
-   * Gets the suffix for number, by type
-   * @param {string} type - type of number for calculate suffix
-   * @returns {string} suffix for number, by type
-   **/
-  getNumericValueSuffix(type: string): string;
-  /**
-   * Gets the number as string, formatted by actual browser locale, with suffix by type
-   * @param {number} input number
-   * @param {number} decimals number of significant decimal digits for output
-   * @param {string} type - type of number for calculate suffix
-   * @returns {string} number as string, formatted by actual browser locale, with suffix by type
-   **/
-  numberToFormattedString(input: number, decimals: number, type: string): string;
-  /**
-   * Gets the number as string, formatted by actual browser locale, with suffix by type
-   * @param {string} input number as string, formatted by locale US, decimal separator . (like java decimal numbers)
-   * @param {number} decimals number of significant decimal digits for output
-   * @param {string} type - type of number for calculate suffix
-   * @param {string} decSeparator decimal separator for output string
-   * @returns {string} number as string, formatted by actual browser locale (or using decimal separator param), with suffix by type
-   **/
-  numberStringToFormattedString(input: string, decimals: number, type: string, decSeparator?: string): string;
-  /**
-   * Registers a KupComponent in KupMath, in order to be properly handled whenever the locale changes.
-   * @param {any} component - The Ketchup component to be registered.
-   */
-  register(component: any): void;
-  /**
-   * Unregisters a KupComponent, so it won't be refreshed when the locale changes.
-   *
-   * @param {any} component - The component calling this function.
-   */
-  unregister(component: any): void;
+    formulas: KupMathFormulas;
+    locale: KupMathLocales;
+    managedComponents: Set<KupComponent>;
+    numbers: KupMathNumbers;
+    numeral: typeof numeral;
+    /**
+     * Initializes KupMath.
+     */
+    constructor(locale?: KupMathLocales);
+    /**
+     * Sets the locale of the numeral instance. The locales available must be tied to the KupDates locales.
+     * @param {KupMathLocales} locale - Numeraljs locale string.
+     */
+    setLocale(locale: KupMathLocales): void;
+    /**
+     * Calculates the normal distribution on a set of values.
+     * @param {string[] | number[] | String[]} values - Array of values.
+     * @param {number} precision - Number of iterations to run (points). When not specified, defaults to 201.
+     * @returns {number[][]} Returns an array of arrays containing numbers, which are the representation of the calculated normal distribution.
+     */
+    normalDistribution(values: string[] | number[] | String[], precision?: number): number[][];
+    /**
+     * Formats the input number with the specified format of the currently set locale.
+     * @param {string | String | number} input - Input number which will be automatically "numberified".
+     * @param {string} format - Desired format. Defaults to '0,0.00' (i.e.: 2,000,000.51).
+     * @param {boolean} inputIsLocalized Numberifies assuming the input string is in the current KupMath locale's format.
+     * @returns {string} Formatted number.
+     */
+    format(input: string | String | number, format?: string, inputIsLocalized?: boolean): string;
+    /**
+     * Create the pattern string for format a number
+     * @param {boolean} thousandPoint - show thousandPoint
+     * @param {number} decimals - number of decimals
+     * @returns {string} - formatter pattern
+     */
+    createFormatPattern(thousandPoint?: boolean, decimals?: number): string;
+    /**
+     * Returns the decimal separator of current browser
+     * @returns {string} current decimal separator, by locale
+     */
+    decimalSeparator(): string;
+    /**
+     * Returns the group separator of current browser
+     * @returns {string} current group separator, by locale
+     */
+    groupSeparator(): string;
+    /**
+     * Checks if an input string matches options, for desired formatted decimal number (integer digits, decimal digits)
+     * @param {string} value the input value to check
+     * @param {NumericFieldFormatOptions} options options for customize the check
+     * @returns {RegExpMatchArray} an object from applying the regular expression for check
+     */
+    matchNumericValueWithOptions(value: string, options: NumericFieldFormatOptions): RegExpMatchArray;
+    /**
+     * Returns a number from a non-specified input type between string, number, or String.
+     * @param {string | String | number} input - Input value to numberify.
+     * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
+     * @param {string} type - type of number for calculate suffix
+     * @param {string} decFmt - decimal format for the input value.
+     * @returns {number} Resulting number or NaN (when not a number).
+     */
+    numberify(input: string | String | number, inputIsLocalized?: boolean, type?: string, decFmt?: string): number;
+    /**
+     * Returns a number from a non-specified input type between string, number, or String.
+     * If value in is null, undefined or blank, returns 0
+     * @param {string} input number as string, formatted by locale US, decimal separator . (like java decimal numbers)
+     * @param {boolean} inputIsLocalized - Numberifies assuming the input string is in the current KupMath locale's format.
+     * @param {string} type - type of number for calculate suffix
+     * @returns {number} Resulting number
+     **/
+    numberifySafe(input: string, inputIsLocalized?: boolean, type?: string, decFmt?: string): number;
+    /**
+     * Checks if input is a valid number
+     * @param {any} value input value to check
+     * @returns {boolean} if input value is valid number
+     */
+    isNumber(value: any): boolean;
+    /**
+     * Checks if string in input is a valid formatted number
+     * @param {string} value number as string, formatted by actual browser locale
+     * @param {string} type - type of number for calculate suffix
+     * @returns {boolean} true if number string in input is a valid number
+     */
+    isStringNumber(value: string, type: string): boolean;
+    /**
+     * Gets number as string, formatted by locale US, decimal separator . (like java decimal numbers)
+     * @param {string} input number as string, formatted by actual browser locale (maybe)
+     * @param {string} type - type of number for calculate suffix
+     * @param {string} decSeparator - decimal serparator of input string
+     * @returns {string} number as string, formatted by locale US, decimal separator . (like java decimal numbers), without group separator
+     **/
+    formattedStringToNumberString(input: string, type: string, decSeparator?: string): string;
+    /**
+     * Gets the number of decimals for current number
+     * @param {number} value numer input
+     * @returns {number} the number of decimals
+     */
+    countDecimals(value: number): number;
+    /**
+     * Gets the suffix for number, by type
+     * @param {string} type - type of number for calculate suffix
+     * @returns {string} suffix for number, by type
+     **/
+    getNumericValueSuffix(type: string): string;
+    /**
+     * Gets the number as string, formatted by actual browser locale, with suffix by type
+     * @param {number} input number
+     * @param {number} decimals number of significant decimal digits for output
+     * @param {string} type - type of number for calculate suffix
+     * @returns {string} number as string, formatted by actual browser locale, with suffix by type
+     **/
+    numberToFormattedString(input: number, decimals: number, type: string): string;
+    /**
+     * Gets the number as string, formatted by actual browser locale, with suffix by type
+     * @param {string} input number as string, formatted by locale US, decimal separator . (like java decimal numbers)
+     * @param {number} decimals number of significant decimal digits for output
+     * @param {string} type - type of number for calculate suffix
+     * @param {string} decSeparator decimal separator for output string
+     * @returns {string} number as string, formatted by actual browser locale (or using decimal separator param), with suffix by type
+     **/
+    numberStringToFormattedString(input: string, decimals: number, type: string, decSeparator?: string): string;
+    /**
+     * Registers a KupComponent in KupMath, in order to be properly handled whenever the locale changes.
+     * @param {any} component - The Ketchup component to be registered.
+     */
+    register(component: any): void;
+    /**
+     * Unregisters a KupComponent, so it won't be refreshed when the locale changes.
+     *
+     * @param {any} component - The component calling this function.
+     */
+    unregister(component: any): void;
 }

package/dist/types/managers/kup-objects/kup-objects-declarations.d.ts

@@ -3,13 +3,13 @@
  * << To be implemented, still a draft. >>
  */
 export interface KupObjectsJSON {
-  [index: string]: any;
+    [index: string]: any;
 }
 /**
  * The composition of an object consists of: type, parameter, key.
  */
 export interface KupObj {
-  t: string;
-  p: string;
-  k: string;
+    t: string;
+    p: string;
+    k: string;
 }