@sme.up/ketchup 8.0.1 → 8.1.0

package/dist/types/components/kup-planner/kup-planner.d.ts

@@ -1,212 +1,266 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { GenericObject } from '../../types/GenericTypes';
-import { KupPlannerEventPayload, KupPlannerGanttTask, KupPlannerPhase, KupPlannerTaskAction, KupPlannerDetail, KupPlannerClickEventPayload } from './kup-planner-declarations';
-import React from 'react';
-import { KupDataDataset } from '../../managers/kup-data/kup-data-declarations';
-import { GanttRow, PlannerProps } from '@sme.up/gantt-component';
-export declare class KupPlanner {
-  #private;
-  /**
-   * References the root HTML element of the component (<kup-planner>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Dataset containg the tasks list
-   * @default null
-   */
-  data: KupDataDataset;
-  /**
-   * Dataset containg the details list
-   * @default null
-   */
-  detailData: KupDataDataset;
-  /**
-   * Column containing the detail color, in hex format
-   * @default null
-   */
-  detailColorCol: string;
-  /**
-   * Columns containing informations displayed in the left box, near the gantt of details
-   * @default null
-   */
-  detailColumns: string[];
-  /**
-   * Columns containing detail duration, from (firstDate) to (secondDate)
-   * @default null
-   */
-  detailDates: string[];
-  /**
-   * Height for detail gantt
-   * @default null
-   */
-  detailHeight: number;
-  /**
-   * Column containing icon name to show, for detail
-   * @default null
-   */
-  detailIconCol: string;
-  /**
-   * Column containing unique detail identifier
-   * @default null
-   */
-  detailIdCol: string;
-  /**
-   * Column containing detail name displayed
-   * @default null
-   */
-  detailNameCol: string;
-  /**
-   * Columns containing forecast detail duration, from (firstDate) to (secondDate)
-   * @default null
-   */
-  detailPrevDates: string[];
-  /**
-   * Total size of the cells inside to the left box, near the gantt
-   * @default '300px'
-   */
-  listCellWidth: string;
-  /**
-   * Max width for component
-   * @default '90vw'
-   */
-  maxWidth: string;
-  /**
-   * Column containing the phase color in hex format
-   * @default null
-   */
-  phaseColorCol: string;
-  /**
-   * Columns containing informations displayed in the left box ,near the gantt of phases
-   * @default null
-   */
-  phaseColumns: string[];
-  /**
-   * Column containing the name of the parent phases
-   * @default null
-   */
-  phaseColParDep: string;
-  /**
-   * Columns containing phase duration, from (firstDate) to (secondDate)
-   * @default null
-   */
-  phaseDates: string[];
-  /**
-   * Column containing icon name to show, for phase
-   * @default null
-   */
-  phaseIconCol: string;
-  /**
-   * Column containing unique phase identifier
-   * @default null
-   */
-  phaseIdCol: string;
-  /**
-   * Column containing phase name displayed
-   * @default null
-   */
-  phaseNameCol: string;
-  /**
-   * Columns containing forecast phase duration, from (firstDate) to (secondDate)
-   * @default null
-   */
-  phasePrevDates: string[];
-  /**
-   * Enable/disable display of secondary dates
-   * @default false
-   */
-  showSecondaryDates: boolean;
-  /**
-   * Columns containing informations displayed in the left box, near the gantt
-   * @default null
-   */
-  taskColumns: string[];
-  /**
-   * Columns containing task duration, from (firstDate) to (secondDate)
-   * @default null
-   */
-  taskDates: string[];
-  /**
-   * Height for main gantt
-   * @default null
-   */
-  taskHeight: number;
-  /**
-   * Column containing icon name to show, for task
-   * @default null
-   */
-  taskIconCol: string;
-  /**
-   * Column containing unique task identifier
-   * @default null
-   */
-  taskIdCol: string;
-  /**
-   * Column containing task name displayed
-   * @default null
-   */
-  taskNameCol: string;
-  /**
-   * Columns containing forecast task duration, from (firstDate) to (secondDate)
-   * @default null
-   */
-  taskPrevDates: string[];
-  /**
-   * Message displayed on top
-   * @default null
-   */
-  titleMess: string;
-  /**
-   * The value of the component.
-   * @default ""
-   */
-  plannerProps: PlannerProps;
-  dataChanged(): void;
-  showSecondaryDatesChanged(): void;
-  kupClick: EventEmitter<KupPlannerEventPayload>;
-  kupDateChange: EventEmitter<KupPlannerEventPayload>;
-  kupReady: EventEmitter<KupPlannerEventPayload>;
-  /**
-   * Generic right click event on planner.
-   */
-  kupContextMenu: EventEmitter<KupPlannerClickEventPayload>;
-  /**
-   * Used to retrieve component's props values.
-   * @param {boolean} descriptions - When provided and true, the result will be the list of props with their description.
-   * @returns {Promise<GenericObject>} List of props as object, each key will be a prop.
-   */
-  getProps(descriptions?: boolean): Promise<GenericObject>;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  refresh(): Promise<void>;
-  /**
-   * Sets the props to the component.
-   * @param {GenericObject} props - Object containing props that will be set to the component.
-   */
-  setProps(props: GenericObject): Promise<void>;
-  /**
-   * Add a list of phases to the project
-   * @param taskId
-   * @param data - Matrix which contains project phases
-   */
-  addPhases(taskId: string, data: KupDataDataset): Promise<void>;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  onKupClick(event: GanttRow, taskAction?: KupPlannerTaskAction): void;
-  onKupContextMenu(event: React.MouseEvent<Element, MouseEvent>, ganttRow: GanttRow, taskAction?: KupPlannerTaskAction): void;
-  onKupDateChange(event: GanttRow, taskAction?: KupPlannerTaskAction): void;
-  handleOnClick(nativeEvent: KupPlannerGanttTask | KupPlannerPhase | KupPlannerDetail): void;
-  handleOnContextMenu(event: React.MouseEvent<Element, MouseEvent>, row: KupPlannerGanttTask | KupPlannerPhase | KupPlannerDetail): void;
-  handleOnSetDoubleView(checked: boolean): void;
-  handleOnDateChange(nativeEvent: KupPlannerGanttTask | KupPlannerPhase | KupPlannerDetail): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GenericObject } from '../../types/GenericTypes';
+import { KupPlannerEventPayload, KupPlannerGanttTask, KupPlannerPhase, KupPlannerTaskAction, KupPlannerDetail, KupPlannerClickEventPayload, KupPlannerViewMode, KupPlannerUnloadEventPayload } from './kup-planner-declarations';
+import React from 'react';
+import { KupDataDataset } from '../../managers/kup-data/kup-data-declarations';
+import { GanttRow, PlannerProps } from '@sme.up/gantt-component';
+import { KupPlannerState } from './kup-planner-state';
+import { KupStore } from '../kup-state/kup-store';
+export declare class KupPlanner {
+  #private;
+  stateId: string;
+  store: KupStore;
+  state: KupPlannerState;
+  initWithPersistedState(): void;
+  persistState(): void;
+  /**
+   * References the root HTML element of the component (<kup-planner>).
+   */
+  rootElement: HTMLElement;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Dataset containg the tasks list
+   * @default null
+   */
+  data: KupDataDataset;
+  /**
+   * Dataset containg the details list
+   * @default null
+   */
+  detailData: KupDataDataset;
+  /**
+   * Column containing the detail color, in hex format
+   * @default null
+   */
+  detailColorCol: string;
+  /**
+   * Columns containing informations displayed in the left box, near the gantt of details
+   * @default null
+   */
+  detailColumns: string[];
+  /**
+   * Columns containing detail duration, from (firstDate) to (secondDate)
+   * @default null
+   */
+  detailDates: string[];
+  /**
+   * Sets the detail's filter.
+   * @default undefined
+   */
+  detailFilter: string;
+  /**
+   * Height for detail gantt
+   * @default null
+   */
+  detailHeight: number;
+  /**
+   * Column containing icon name to show, for detail
+   * @default null
+   */
+  detailIconCol: string;
+  /**
+   * Column containing unique detail identifier
+   * @default null
+   */
+  detailIdCol: string;
+  /**
+   * Column containing detail name displayed
+   * @default null
+   */
+  detailNameCol: string;
+  /**
+   * Columns containing forecast detail duration, from (firstDate) to (secondDate)
+   * @default null
+   */
+  detailPrevDates: string[];
+  /**
+   * Sets the initial scroll X for the detail.
+   * @default undefined
+   */
+  detailInitialScrollX: number;
+  /**
+   * Sets the initial scroll Y for the detail.
+   * @default undefined
+   */
+  detailInitialScrollY: number;
+  /**
+   * Total size of the cells inside to the left box, near the gantt
+   * @default '300px'
+   */
+  listCellWidth: string;
+  /**
+   * Max width for component
+   * @default '90vw'
+   */
+  maxWidth: string;
+  /**
+   * Column containing the phase color in hex format
+   * @default null
+   */
+  phaseColorCol: string;
+  /**
+   * Columns containing informations displayed in the left box ,near the gantt of phases
+   * @default null
+   */
+  phaseColumns: string[];
+  /**
+   * Column containing the name of the parent phases
+   * @default null
+   */
+  phaseColParDep: string;
+  /**
+   * Columns containing phase duration, from (firstDate) to (secondDate)
+   * @default null
+   */
+  phaseDates: string[];
+  /**
+   * Column containing icon name to show, for phase
+   * @default null
+   */
+  phaseIconCol: string;
+  /**
+   * Column containing unique phase identifier
+   * @default null
+   */
+  phaseIdCol: string;
+  /**
+   * Column containing phase name displayed
+   * @default null
+   */
+  phaseNameCol: string;
+  /**
+   * Columns containing forecast phase duration, from (firstDate) to (secondDate)
+   * @default null
+   */
+  phasePrevDates: string[];
+  /**
+   * When true, the two gantts are not interactable.
+   * @default false
+   */
+  readOnly: boolean;
+  /**
+   * Enable/disable display of secondary dates
+   * @default false
+   */
+  showSecondaryDates: boolean;
+  /**
+   * Columns containing informations displayed in the left box, near the gantt
+   * @default null
+   */
+  taskColumns: string[];
+  /**
+   * Columns containing task duration, from (firstDate) to (secondDate)
+   * @default null
+   */
+  taskDates: string[];
+  /**
+   * Sets the task's filter.
+   * @default undefined
+   */
+  taskFilter: string;
+  /**
+   * Height for main gantt
+   * @default null
+   */
+  taskHeight: number;
+  /**
+   * Column containing icon name to show, for task
+   * @default null
+   */
+  taskIconCol: string;
+  /**
+   * Column containing unique task identifier
+   * @default null
+   */
+  taskIdCol: string;
+  /**
+   * Sets the initial scroll X for the task.
+   * @default undefined
+   */
+  taskInitialScrollX: number;
+  /**
+   * Sets the initial scroll Y for the task.
+   * @default undefined
+   */
+  taskInitialScrollY: number;
+  /**
+   * Column containing task name displayed
+   * @default null
+   */
+  taskNameCol: string;
+  /**
+   * Columns containing forecast task duration, from (firstDate) to (secondDate)
+   * @default null
+   */
+  taskPrevDates: string[];
+  /**
+   * Message displayed on top
+   * @default null
+   */
+  titleMess: string;
+  /**
+   * Sets the view mode.
+   * @default 'month'
+   */
+  viewMode: KupPlannerViewMode;
+  /**
+   * The value of the component.
+   * @default ""
+   */
+  plannerProps: PlannerProps;
+  dataChanged(): void;
+  kupClick: EventEmitter<KupPlannerEventPayload>;
+  kupDateChange: EventEmitter<KupPlannerEventPayload>;
+  kupReady: EventEmitter<KupPlannerEventPayload>;
+  /**
+   * Generic right click event on planner.
+   */
+  kupContextMenu: EventEmitter<KupPlannerClickEventPayload>;
+  /**
+   * When component unload is complete
+   */
+  kupDidUnload: EventEmitter<KupPlannerUnloadEventPayload>;
+  /**
+   * Used to retrieve component's props values.
+   * @param {boolean} descriptions - When provided and true, the result will be the list of props with their description.
+   * @returns {Promise<GenericObject>} List of props as object, each key will be a prop.
+   */
+  getProps(descriptions?: boolean): Promise<GenericObject>;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  refresh(): Promise<void>;
+  /**
+   * Sets the props to the component.
+   * @param {GenericObject} props - Object containing props that will be set to the component.
+   */
+  setProps(props: GenericObject): Promise<void>;
+  /**
+   * Add a list of phases to the project
+   * @param taskId
+   * @param data - Matrix which contains project phases
+   */
+  addPhases(taskId: string, data: KupDataDataset): Promise<void>;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  onKupClick(event: GanttRow, taskAction?: KupPlannerTaskAction): void;
+  onKupContextMenu(event: React.MouseEvent<Element, MouseEvent>, ganttRow: GanttRow, taskAction?: KupPlannerTaskAction): void;
+  onKupDateChange(event: GanttRow, taskAction?: KupPlannerTaskAction): void;
+  handleOnClick(nativeEvent: KupPlannerGanttTask | KupPlannerPhase | KupPlannerDetail): void;
+  handleOnContextMenu(event: React.MouseEvent<Element, MouseEvent>, row: KupPlannerGanttTask | KupPlannerPhase | KupPlannerDetail): void;
+  handleOnSetDoubleView(checked: boolean): void;
+  handleOnSetViewMode(value: KupPlannerViewMode): void;
+  handleOnScrollX(x: number): void;
+  handleTaskGanttScrollY(y: number): void;
+  handleDetailGanttScrollY(y: number): void;
+  handleOnDateChange(nativeEvent: KupPlannerGanttTask | KupPlannerPhase | KupPlannerDetail): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

package/dist/types/components/kup-probe/kup-probe.d.ts

@@ -1,72 +1,72 @@
-export declare class KupProbe {
-  /**
-   * References the root HTML element of the component (<kup-probe>).
-   */
-  rootElement: HTMLElement;
-  /**
-   * Lifecycle time.
-   * @default null
-   */
-  content: string;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Specify features to test.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  features: {
-    debug: boolean;
-    language: boolean;
-    longCycleProp: boolean;
-    longCycleVar: boolean;
-    objects: boolean;
-    objectsFunction: boolean;
-    theme: boolean;
-  };
-  /**
-   * Uncomment the code below to test render times with many props (100).
-   */
-  /**
-   * Instance of the KupManager class.
-   */
-  private kupManager;
-  /**
-   * Start performance.now()
-   */
-  private startTime;
-  /**
-   * Start performance.now() inside componentWillLoad() lifecycle hook - to measure actual features
-   */
-  private featuresStartTime;
-  /**
-   * End performance.now()
-   */
-  private endTime;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  printLifecycleTime(): Promise<{
-    id: string;
-    featuresTime: number;
-    fullTime: number;
-  }>;
-  /**
-   * This method is used to trigger a new render of the component.
-   */
-  refresh(): Promise<void>;
-  private longCycleProp;
-  private longCycleVar;
-  private longCycleObjects;
-  private longCycleObjectsFunction;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+export declare class KupProbe {
+  /**
+   * References the root HTML element of the component (<kup-probe>).
+   */
+  rootElement: HTMLElement;
+  /**
+   * Lifecycle time.
+   * @default null
+   */
+  content: string;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Specify features to test.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  features: {
+    debug: boolean;
+    language: boolean;
+    longCycleProp: boolean;
+    longCycleVar: boolean;
+    objects: boolean;
+    objectsFunction: boolean;
+    theme: boolean;
+  };
+  /**
+   * Uncomment the code below to test render times with many props (100).
+   */
+  /**
+   * Instance of the KupManager class.
+   */
+  private kupManager;
+  /**
+   * Start performance.now()
+   */
+  private startTime;
+  /**
+   * Start performance.now() inside componentWillLoad() lifecycle hook - to measure actual features
+   */
+  private featuresStartTime;
+  /**
+   * End performance.now()
+   */
+  private endTime;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  printLifecycleTime(): Promise<{
+    id: string;
+    featuresTime: number;
+    fullTime: number;
+  }>;
+  /**
+   * This method is used to trigger a new render of the component.
+   */
+  refresh(): Promise<void>;
+  private longCycleProp;
+  private longCycleVar;
+  private longCycleObjects;
+  private longCycleObjectsFunction;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

package/dist/types/components/kup-progress-bar/kup-progress-bar-declarations.d.ts

@@ -1,13 +1,13 @@
-/**
- * Props of the kup-progress-bar component.
- * Used to export every prop in an object.
- */
-export declare enum KupProgressBarProps {
-  centeredLabel = "Displays the label in the middle of the progress bar. It's the default for the radial variant and can't be changed.",
-  customStyle = "Custom style of the component.",
-  hideLabel = "Flag to show or hide the progress bar's label.",
-  icon = "Specifies an icon to replace the label.",
-  label = "Specifies a text for the bar's label.",
-  isRadial = "Radial version.",
-  value = "The current value the progress bar must display."
-}
+/**
+ * Props of the kup-progress-bar component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupProgressBarProps {
+  centeredLabel = "Displays the label in the middle of the progress bar. It's the default for the radial variant and can't be changed.",
+  customStyle = "Custom style of the component.",
+  hideLabel = "Flag to show or hide the progress bar's label.",
+  icon = "Specifies an icon to replace the label.",
+  label = "Specifies a text for the bar's label.",
+  isRadial = "Radial version.",
+  value = "The current value the progress bar must display."
+}