@sme.up/ketchup 6.2.0 → 6.3.0

package/dist/types/components/kup-text-field/kup-text-field.d.ts

@@ -17,6 +17,11 @@ export declare class KupTextField {
    * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
    */
   customStyle: string;
+  /**
+   * Number of decimals (should be used when inputType is number).
+   * @default null
+   */
+  decimals: number;
   /**
    * When set to true, the component is disabled.
    * @default false

package/dist/types/components.d.ts

@@ -32,7 +32,7 @@ import { KupDropdownButtonEventPayload } from "./components/kup-dropdown-button/
 import { KupEchartClickEventPayload, KupEchartLegendPlacement, KupEchartMaps, KupEchartTitle, KupEchartTypes } from "./components/kup-echart/kup-echart-declarations";
 import { GeoJSON } from "geojson";
 import { XAXisComponentOption, YAXisComponentOption } from "echarts";
-import { KupFamilyTreeData, KupFamilyTreeEventPayload } from "./components/kup-family-tree/kup-family-tree-declarations";
+import { KupFamilyTreeData, KupFamilyTreeEventPayload, KupFamilyTreeLayout, KupFamilyTreeNode } from "./components/kup-family-tree/kup-family-tree-declarations";
 import { KupFormData, KupFormLayout } from "./components/kup-form/kup-form-declarations";
 import { KupBadge } from "./components/kup-badge/kup-badge";
 import { FImageData } from "./f-components/f-image/f-image-declarations";
@@ -1572,10 +1572,19 @@ export namespace Components {
     }
     interface KupFamilyTree {
         /**
-          * The component's initial render will fit the container.
+          * The component will autofit everytime a node is expanded.
           * @default true
          */
-        "autofit": boolean;
+        "autofitOnExpand": boolean;
+        /**
+          * The component's initial render will fit the container by invoking the runAutofit method.
+          * @default true
+         */
+        "autofitOnLoad": boolean;
+        /**
+          * Collapses all nodes.
+         */
+        "collapseAll": (nodes?: KupFamilyTreeNode[]) => Promise<void>;
         /**
           * Nodes can be expanded/collapsed.
           * @default true
@@ -1592,6 +1601,10 @@ export namespace Components {
           * @default null
          */
         "data": KupFamilyTreeData;
+        /**
+          * Expands all nodes.
+         */
+        "expandAll": (nodes?: KupFamilyTreeNode[]) => Promise<void>;
         /**
           * Used to retrieve component's props values.
           * @param descriptions - When provided and true, the result will be the list of props with their description.
@@ -1602,16 +1615,25 @@ export namespace Components {
           * Layout of the boxes.
           * @default null
          */
-        "layout": KupBoxLayout;
+        "layout": KupFamilyTreeLayout;
         /**
           * This method is used to trigger a new render of the component.
          */
         "refresh": () => Promise<void>;
+        /**
+          * This method causes the component to autofit its container's width.
+         */
+        "runAutofit": () => Promise<void>;
         /**
           * Sets the props to the component.
           * @param props - Object containing props that will be set to the component.
          */
         "setProps": (props: GenericObject) => Promise<void>;
+        /**
+          * Child nodes that have no children are arranged vertically.
+          * @default false
+         */
+        "stackedLeaves": boolean;
     }
     interface KupForm {
         /**
@@ -2618,6 +2640,11 @@ export namespace Components {
           * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
          */
         "customStyle": string;
+        /**
+          * Number of decimals (should be used when inputType is number).
+          * @default null
+         */
+        "decimals": number;
         /**
           * When set to true, the component is disabled.
           * @default false
@@ -4757,10 +4784,15 @@ declare namespace LocalJSX {
     }
     interface KupFamilyTree {
         /**
-          * The component's initial render will fit the container.
+          * The component will autofit everytime a node is expanded.
+          * @default true
+         */
+        "autofitOnExpand"?: boolean;
+        /**
+          * The component's initial render will fit the container by invoking the runAutofit method.
           * @default true
          */
-        "autofit"?: boolean;
+        "autofitOnLoad"?: boolean;
         /**
           * Nodes can be expanded/collapsed.
           * @default true
@@ -4781,10 +4813,15 @@ declare namespace LocalJSX {
           * Layout of the boxes.
           * @default null
          */
-        "layout"?: KupBoxLayout;
+        "layout"?: KupFamilyTreeLayout;
         "onKup-familytree-click"?: (event: KupFamilyTreeCustomEvent<KupFamilyTreeEventPayload>) => void;
         "onKup-familytree-contextmenu"?: (event: KupFamilyTreeCustomEvent<KupFamilyTreeEventPayload>) => void;
         "onKup-familytree-dblclick"?: (event: KupFamilyTreeCustomEvent<KupFamilyTreeEventPayload>) => void;
+        /**
+          * Child nodes that have no children are arranged vertically.
+          * @default false
+         */
+        "stackedLeaves"?: boolean;
     }
     interface KupForm {
         /**
@@ -5536,6 +5573,11 @@ declare namespace LocalJSX {
           * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
          */
         "customStyle"?: string;
+        /**
+          * Number of decimals (should be used when inputType is number).
+          * @default null
+         */
+        "decimals"?: number;
         /**
           * When set to true, the component is disabled.
           * @default false

package/dist/types/f-components/f-text-field/f-text-field-declarations.d.ts

@@ -3,6 +3,7 @@ import type { FComponent } from '../../types/GenericTypes';
  * Props of the f-text-field component.
  */
 export interface FTextFieldProps extends FComponent {
+  decimals?: number;
   disabled?: boolean;
   fullHeight?: boolean;
   fullWidth?: boolean;

package/dist/types/managers/kup-data/kup-data-cell-helper.d.ts

@@ -1,4 +1,6 @@
-import { KupDataCell, KupDataDataset, KupDataFindCellFilters } from './kup-data-declarations';
+import { ValueDisplayedValue } from '../../utils/filters/filters-declarations';
+import { KupObj } from '../kup-objects/kup-objects-declarations';
+import { KupDataCell, KupDataColumn, KupDataDataset, KupDataFindCellFilters } from './kup-data-declarations';
 /**
  * Finds all the cells matching the filters criteria in the input dataset.
  * @param {KupDataDataset} dataset - Input dataset.
@@ -7,12 +9,17 @@ import { KupDataCell, KupDataDataset, KupDataFindCellFilters } from './kup-data-
  */
 export declare function findCell(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataCell[];
 /**
- * Returns all the cells values of the specified columns.
- * @param {KupDataDataset} dataset - Input dataset.
- * @param {string[]} columns - Columns included in the search. When missing, searches all columns.
- * @returns {string[]} Values of the cells.
+ * Returns all the cells values of the specified column, sorted if required.
+ * @param {Array<KupDataRow>} dataset - Input dataset.
+ * @param {KupDataColumn} column - Column included in the search. When missing, returns empty array.
+ * @returns {ValueDisplayedValue[]} Values of the cells, sorted.
  */
-export declare function getCellValue(dataset: KupDataDataset, columns?: string[]): string[];
+export declare function getCellValue(dataset: KupDataDataset, column: KupDataColumn, sorted?: boolean): ValueDisplayedValue[];
+export declare function addColumnValueFromRow(values: {
+  value: string;
+  displayedValue?: string;
+  obj?: KupObj;
+}[], column: KupDataColumn, cell: KupDataCell): void;
 /**
  * Overrides the given cell attributes for the specified columns.
  * If no columns are provided, the value will be applied to every column of the dataset.

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

@@ -1,6 +1,7 @@
 import { KupDataCell, KupDataColumn, KupDataDataset, KupDataDatasetSort, KupDataFindCellFilters, KupDataNewColumn, KupDataNewColumnOptions, KupDataNewColumnTypes, KupDataNode, KupDataNodeDrilldownInfo, KupDataRow } from './kup-data-declarations';
 import { FCellShapes, FCellTypes } from '../../f-components/f-cell/f-cell-declarations';
 import { TreeNodePath } from '../../components/kup-tree/kup-tree-declarations';
+import { ValueDisplayedValue } from '../../utils/filters/filters-declarations';
 /**
  * Handles data operations.
  * @module KupData
@@ -8,7 +9,7 @@ import { TreeNodePath } from '../../components/kup-tree/kup-tree-declarations';
 export declare class KupData {
   cell: {
     find(dataset: KupDataDataset, filters: KupDataFindCellFilters): KupDataCell[];
-    getValue(dataset: KupDataDataset, columns?: string[]): string[];
+    getValue(dataset: KupDataDataset, column: KupDataColumn, sorted?: boolean): ValueDisplayedValue[];
     replace(dataset: KupDataDataset, cell: KupDataCell, columns?: string[]): KupDataCell[];
     getType(cell: KupDataCell, shape?: FCellShapes): FCellTypes;
   };

package/dist/types/managers/kup-scroll-on-hover/kup-scroll-on-hover-declarations.d.ts

@@ -5,15 +5,23 @@ export interface KupScrollOnHoverElement extends HTMLElement {
   scrollOnHover: {
     active: boolean;
     children: NodeListOf<HTMLElement>;
+    percentages: KupScrollOnHoverPercentages;
     rect: DOMRect;
+    vertical: boolean;
     x: number;
     y: number;
   };
 }
+export interface KupScrollOnHoverPercentages {
+  back: number;
+  forward: number;
+}
 /**
  * The direction to which ScollableElement can be scrolled.
  */
 export declare enum ScrollOnHoverDirection {
+  BOTTOM = "bottom",
   LEFT = "left",
-  RIGHT = "right"
+  RIGHT = "right",
+  TOP = "top"
 }

package/dist/types/managers/kup-scroll-on-hover/kup-scroll-on-hover.d.ts

@@ -1,4 +1,4 @@
-import { KupScrollOnHoverElement, ScrollOnHoverDirection } from './kup-scroll-on-hover-declarations';
+import { KupScrollOnHoverElement, KupScrollOnHoverPercentages, ScrollOnHoverDirection } from './kup-scroll-on-hover-declarations';
 /**
  * Lets the user scroll an element's overflow by hovering with the mouse on its left/right edge.
  * @module KupScrollOnHover
@@ -19,8 +19,10 @@ export declare class KupScrollOnHover {
    * Watches the given element in order to trigger the scroll on hover when conditions are met.
    * Children nodes with the "hover-scrolling-child" will be watched and scrolled when el scrolls.
    * @param {KupScrollOnHoverElement} el - Element to watch.
+   * @param {boolean} vertical - Enables vertical scroll.
+   * @param {KupScrollOnHoverPercentages} percentages - Sets how big is the area in which the scroll is enabled.
    */
-  register(el: KupScrollOnHoverElement): void;
+  register(el: KupScrollOnHoverElement, vertical?: boolean, percentages?: KupScrollOnHoverPercentages): void;
   /**
    * Removes the given element from ScrollOnHover watchlist.
    * @param {KupScrollOnHoverElement} el - Element to unregister.
@@ -46,11 +48,11 @@ export declare class KupScrollOnHover {
    * The actual recursive scroll function.
    * @param {KupScrollOnHoverElement} el - The scrolled element.
    * @param {number} maxScrollLeft - Left coordinates to which the recursiveness must be stopped.
-   * @param {number} percRight - Range of the right scrollable area.
-   * @param {number} percLeft - Range of the left scrollable area.
+   * @param {number} percForward - Range of the right (or bottom) area.
+   * @param {number} percBack - Range of the left (or top) scrollable area.
    * @param {ScrollOnHoverDirection} direction - Direction of the scroll.
    */
-  run(el: KupScrollOnHoverElement, maxScrollLeft: number, percRight: number, percLeft: number, direction: ScrollOnHoverDirection): void;
+  run(el: KupScrollOnHoverElement, maxScrollLeft: number, percForward: number, percBack: number, direction: ScrollOnHoverDirection): void;
   /**
    * Scrolls children of the element having the "hover-scrolling-child" class
    * @param {KupScrollOnHoverElement} el - The scrolled element.

package/dist/types/utils/filters/filters-rows.d.ts

@@ -27,6 +27,4 @@ export declare class FiltersRows extends Filters {
    */
   filterRows(rows?: Array<KupDataRow>, filters?: GenericFilter, globalFilter?: string, columns?: KupDataColumn[], columnFilters?: FiltersColumnMenu): Array<KupDataRow>;
   getColumnValues(comp: KupDataTable | KupTree, column: KupDataColumn, globalFilterValue: string, columnFilters?: FiltersColumnMenu): ValueDisplayedValue[];
-  extractColumnValues(rows: Array<KupDataRow>, column: KupDataColumn, values: ValueDisplayedValue[]): ValueDisplayedValue[];
-  addColumnValueFromRow(values: ValueDisplayedValue[], column: KupDataColumn, cell: KupDataCell): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@sme.up/ketchup",
-    "version": "6.2.0",
+    "version": "6.3.0",
     "keywords": [
         "smeup",
         "KetchUP",
@@ -56,7 +56,7 @@
         "vanilla-picker": "^2.12.1"
     },
     "devDependencies": {
-        "@stencil/core": "^2.17.0",
+        "@stencil/core": "^2.17.3",
         "@stencil/sass": "^1.4.1",
         "@types/d3-shape": "^3.0.2",
         "@types/geojson": "^7946.0.8",

package/dist/cjs/cell-utils-fe64a28c.js

@@ -1,168 +0,0 @@
-'use strict';
-
-const utils = require('./utils-4b208b48.js');
-const kupManager = require('./kup-manager-02acbb37.js');
-
-const dom = document.documentElement;
-// -------------
-// COMMONS
-// -------------
-function getCellValueForDisplay(column, cell) {
-  if (cell != null) {
-    if (cell.displayedValue != null) {
-      return cell.displayedValue;
-    }
-  }
-  let formattedValue = _getCellValueForDisplay(cell.value, column, cell);
-  if (cell != null) {
-    cell.displayedValue = formattedValue;
-  }
-  return formattedValue;
-}
-function getValueForDisplay2(values, column) {
-  if (values == null) {
-    return '';
-  }
-  if (values.displayedValue == null || values.displayedValue.trim() == '') {
-    values.displayedValue = _getCellValueForDisplay(values.value, column, null);
-  }
-  return values.displayedValue;
-}
-function formatToNumber(cell) {
-  if (cell.obj) {
-    return dom.ketchup.math.numberify(cell.obj.k);
-  }
-  return dom.ketchup.math.numberify(cell.value);
-}
-function _getCellValueForDisplay(value, column, cell) {
-  let obj = column != null ? column.obj : null;
-  if (cell != null) {
-    obj = cell.obj ? cell.obj : obj;
-  }
-  return getValueForDisplay(value, obj, column != null ? column.decimals : null);
-}
-function getValueForDisplay(value, obj, decimals) {
-  if (value == null || value.trim() == '') {
-    return value;
-  }
-  if (dom.ketchup.objects.isNumber(obj)) {
-    return utils.unformattedStringToFormattedStringNumber(value, decimals ? decimals : -1, obj ? obj.p : '');
-  }
-  if (dom.ketchup.objects.isDate(obj) &&
-    dom.ketchup.dates.isValid(value, kupManager.KupDatesFormats.ISO_DATE)) {
-    return dom.ketchup.dates.format(value);
-  }
-  if (dom.ketchup.objects.isTime(obj)) {
-    return utils.unformattedStringToFormattedStringTime(value, dom.ketchup.objects.isTimeWithSeconds(obj), obj.t + obj.p);
-  }
-  if (dom.ketchup.objects.isTimestamp(obj)) {
-    return utils.unformattedStringToFormattedStringTimestamp(value);
-  }
-  return value;
-}
-function getColumnByName(columns, name) {
-  if (columns == null) {
-    return null;
-  }
-  for (let column of columns) {
-    if (column.name === name) {
-      return column;
-    }
-  }
-  return null;
-}
-function compareCell(cell1, cell2, sortMode) {
-  return compareValues(cell1.obj, cell1.value, cell2.obj, cell2.value, sortMode);
-}
-function compareValues(obj1, value1, obj2, value2, sortMode) {
-  const sm = sortMode === 'A' ? 1 : -1;
-  if (obj1 == null || obj2 == null) {
-    return sm * localCompareAsInJava(value1, value2);
-  }
-  // If either the type or the parameter of the current object are not equal.
-  if (!(obj1.t === obj2.t && obj1.p === obj2.p)) {
-    let compare = localCompareAsInJava(obj1.t, obj2.t);
-    if (compare === 0) {
-      compare = localCompareAsInJava(obj1.p, obj2.p);
-    }
-    return compare * sm;
-  }
-  let s1 = value1;
-  let s2 = value2;
-  if (s1 == s2) {
-    return 0;
-  }
-  if (s1 == '') {
-    return sm * -1;
-  }
-  if (s2 == '') {
-    return sm * 1;
-  }
-  let v1 = s1;
-  let v2 = s2;
-  if (dom.ketchup.objects.isNumber(obj1)) {
-    v1 = utils.stringToNumber(s1);
-    v2 = utils.stringToNumber(s2);
-  }
-  else if (dom.ketchup.objects.isDate(obj1)) {
-    v1 = dom.ketchup.dates.toDate(dom.ketchup.dates.format(s1, kupManager.KupDatesFormats.ISO_DATE));
-    v2 = dom.ketchup.dates.toDate(dom.ketchup.dates.format(s2, kupManager.KupDatesFormats.ISO_DATE));
-  }
-  else if (dom.ketchup.objects.isTime(obj1)) {
-    let manageSeconds = dom.ketchup.objects.isTimeWithSeconds(obj1);
-    v1 = dom.ketchup.dates.toDate(dom.ketchup.dates.format(s1, manageSeconds
-      ? kupManager.KupDatesFormats.ISO_TIME
-      : kupManager.KupDatesFormats.ISO_TIME_WITHOUT_SECONDS));
-    v2 = dom.ketchup.dates.toDate(dom.ketchup.dates.format(s2, manageSeconds
-      ? kupManager.KupDatesFormats.ISO_TIME
-      : kupManager.KupDatesFormats.ISO_TIME_WITHOUT_SECONDS));
-  }
-  else if (dom.ketchup.objects.isTimestamp(obj1)) {
-    v1 = dom.ketchup.dates.toDate(dom.ketchup.dates.format(s1, kupManager.KupDatesFormats.ISO_DATE_TIME));
-    v2 = dom.ketchup.dates.toDate(dom.ketchup.dates.format(s2, kupManager.KupDatesFormats.ISO_DATE_TIME));
-  }
-  if (v1 > v2) {
-    return sm * 1;
-  }
-  if (v1 < v2) {
-    return sm * -1;
-  }
-  return 0;
-}
-/**
- * Given two strings to compare, the functions decides which string comes before the other or if they are equal.
- * This is meant as a replacement for the JavaScript function localCompare() which produces a slightly different result from
- * the Java version of compareTo().
- *
- * Re-implemented from java source method compareTo() of java.lang.String
- * @param t1 firstString the first string to be compared
- * @param t2 anotherString the another string to be compared to the first one
- * @returns the value 0 if the anotherString is equal to
- *          firstString; a value less than 0 if firstString
- *          is lexicographically less than the anotherString; and a
- *          value greater than 0 if firstString is
- *          lexicographically greater than the anotherString.
- */
-function localCompareAsInJava(t1, t2) {
-  let t1Length = t1 == null ? 0 : t1.length;
-  let t2Length = t2 == null ? 0 : t2.length;
-  const lim = Math.min(t1Length, t2Length);
-  let k = 0;
-  while (k < lim) {
-    const c1 = t1[k];
-    const c2 = t2[k];
-    if (c1 !== c2) {
-      return c1.charCodeAt(0) - c2.charCodeAt(0);
-    }
-    k++;
-  }
-  return t1Length - t2Length;
-}
-
-exports.compareCell = compareCell;
-exports.compareValues = compareValues;
-exports.formatToNumber = formatToNumber;
-exports.getCellValueForDisplay = getCellValueForDisplay;
-exports.getColumnByName = getColumnByName;
-exports.getValueForDisplay = getValueForDisplay;
-exports.getValueForDisplay2 = getValueForDisplay2;