@sme.up/ketchup 8.0.2 → 8.2.0

package/dist/types/components/kup-photo-frame/kup-photo-frame.d.ts

@@ -1,61 +1,61 @@
-import { EventEmitter } from '../../stencil-public-runtime';
-import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
-export declare class KupPhotoFrame {
-  #private;
-  /**
-   * References the root HTML element of the component (<kup-photo-frame>).
-   */
-  rootElement: HTMLElement;
-  isInViewport: boolean;
-  /**
-   * Custom style of the component.
-   * @default ""
-   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
-   */
-  customStyle: string;
-  /**
-   * Html attributes of the picture before the component enters the viewport.
-   * @default {}
-   */
-  placeholderAttrs: GenericObject;
-  /**
-   * Html attributes of the picture after the component enters the viewport.
-   * @default {}
-   */
-  resourceAttrs: GenericObject;
-  /**
-   * Percentage of the component dimensions entering the viewport (0.1 => 1).
-   * @default 0.25
-   */
-  threshold: number;
-  /**
-   * Triggered when the placeholder is loaded.
-   */
-  kupPhotoFramePlaceholderLoad: EventEmitter<KupEventPayload>;
-  /**
-   * Triggered when the resource is loaded.
-   */
-  kupPhotoFrameResourceLoad: EventEmitter<KupEventPayload>;
-  /**
-   * 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>;
-  setObserver(): void;
-  componentWillLoad(): void;
-  componentDidLoad(): void;
-  componentWillRender(): void;
-  componentDidRender(): void;
-  render(): any;
-  disconnectedCallback(): void;
-}
+import { EventEmitter } from '../../stencil-public-runtime';
+import { GenericObject, KupEventPayload } from '../../types/GenericTypes';
+export declare class KupPhotoFrame {
+  #private;
+  /**
+   * References the root HTML element of the component (<kup-photo-frame>).
+   */
+  rootElement: HTMLElement;
+  isInViewport: boolean;
+  /**
+   * Custom style of the component.
+   * @default ""
+   * @see https://ketchup.smeup.com/ketchup-showcase/#/customization
+   */
+  customStyle: string;
+  /**
+   * Html attributes of the picture before the component enters the viewport.
+   * @default {}
+   */
+  placeholderAttrs: GenericObject;
+  /**
+   * Html attributes of the picture after the component enters the viewport.
+   * @default {}
+   */
+  resourceAttrs: GenericObject;
+  /**
+   * Percentage of the component dimensions entering the viewport (0.1 => 1).
+   * @default 0.25
+   */
+  threshold: number;
+  /**
+   * Triggered when the placeholder is loaded.
+   */
+  kupPhotoFramePlaceholderLoad: EventEmitter<KupEventPayload>;
+  /**
+   * Triggered when the resource is loaded.
+   */
+  kupPhotoFrameResourceLoad: EventEmitter<KupEventPayload>;
+  /**
+   * 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>;
+  setObserver(): void;
+  componentWillLoad(): void;
+  componentDidLoad(): void;
+  componentWillRender(): void;
+  componentDidRender(): void;
+  render(): any;
+  disconnectedCallback(): void;
+}

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

@@ -1,106 +1,127 @@
-/// <reference types="react" />
-import { Detail, GanttTask } from '@sme.up/gantt-component';
-import { Phase } from '@sme.up/gantt-component';
-import { GanttRow } from '@sme.up/gantt-component';
-import { KupEventPayload } from '../../components';
-import { KupDataColumn, KupDataRow } from '../../managers/kup-data/kup-data-declarations';
-import { KupDataTableCell } from '../kup-data-table/kup-data-table-declarations';
-/**
- * Props of the kup-gantt component.
- * Used to export every prop in an object.
- */
-export declare enum KupPlannerProps {
-  customStyle = "Custom style of the component.",
-  data = "Dataset containg the tasks list",
-  detailData = "Dataset containg the details list",
-  detailColorCol = "Column containing the detail color, in hex format",
-  detailColumns = "Columns containing informations displayed in the left box, near the gantt of details",
-  detailDates = "Columns containing detail duration, from (firstDate) to (secondDate)",
-  detailHeight = "Height for detail gantt",
-  detailIdCol = "Column containing unique detail identifier",
-  detailNameCol = "Column containing detail name displayed",
-  detailPrevDates = "Columns containing forecast detail duration, from (firstDate) to (secondDate)",
-  listCellWidth = "Total size of the cells inside to the left box, near the gantt",
-  maxWidth = "Max width for component",
-  phaseColorCol = "Column containing the phase color in hex format",
-  phaseColumns = "Columns containing informations displayed in the left box ,near the gantt of phases",
-  phaseColParDep = "Column containing the name of the parent phases",
-  phaseDates = "Columns containing phase duration, from (firstDate) to (secondDate)",
-  phaseIdCol = "Column containing unique phase identifier",
-  phaseNameCol = "Column containing phase name displayed",
-  phasePrevDates = "Columns containing forecast phase duration, from (firstDate) to (secondDate)",
-  showSecondaryDates = "Enable/disable display of secondary dates",
-  taskColumns = "Columns containing informations displayed in the left box, near the gantt",
-  taskDates = "Columns containing task duration, from (firstDate) to (secondDate)",
-  taskHeight = "Height for main gantt",
-  taskIdCol = "Column containing unique task identifier",
-  taskNameCol = "Column containing task name displayed",
-  taskPrevDates = "Columns containing forecast task duration, from (firstDate) to (secondDate)",
-  titleMess = "Message displayed on top"
-}
-export declare enum KupPlannerTaskAction {
-  onTaskOpening = "onTaskOpening",
-  onTaskClosing = "onTaskClosing",
-  onClick = "onClick",
-  onResize = "onResize",
-  onRightClick = "onRightClick"
-}
-export interface KupPlannerEventPayload extends KupEventPayload {
-  value: GanttRow;
-  taskAction?: KupPlannerTaskAction;
-}
-export interface KupPlannerClickEventPayload extends KupPlannerEventPayload {
-  details: KupPlannerEventHandlerDetails;
-}
-export interface KupPlannerEventHandlerDetails {
-  cell: KupDataTableCell;
-  column: KupDataColumn;
-  originalEvent: React.MouseEvent<Element, MouseEvent>;
-  row: KupDataRow;
-}
-export declare enum KupPlannerGanttRowType {
-  TASK = "task",
-  PHASE = "phase",
-  DETAIL = "detail"
-}
-export interface KupPlannerGanttTask extends GanttTask {
-  taskRowId: string;
-  taskRow: KupDataRow;
-  rowType: KupPlannerGanttRowType;
-}
-export interface KupPlannerDetail extends Detail {
-  rowType: KupPlannerGanttRowType;
-  detailRow: KupDataRow;
-}
-export interface KupPlannerPhase extends Phase {
-  taskRowId: string;
-  taskRow: KupDataRow;
-  phaseRowId: string;
-  phaseRow: KupDataRow;
-  rowType: KupPlannerGanttRowType;
-}
-export declare class KupPlannerLastOnChangeReceived {
-  private event;
-  private dateTime;
-  private threshold;
-  constructor(event: GanttRow, threshold?: number);
-  isEquivalent(newEvent: GanttRow): boolean;
-  resetDateTime(): void;
-}
-export declare const defaultStylingOptions: {
-  listCellWidth: string;
-  rowHeight: number;
-  barFill: number;
-  projectProgressColor: string;
-  projectProgressSelectedColor: string;
-  projectBackgroundColor: string;
-  projectBackgroundSelectedColor: string;
-  barProgressColor: string;
-  barProgressSelectedColor: string;
-  barBackgroundColor: string;
-  barBackgroundSelectedColor: string;
-};
-export interface KupPlannerDatesSanitized {
-  dateValues: string[];
-  secDateValues: string[];
-}
+/// <reference types="react" />
+import { Detail, GanttTask } from '@sme.up/gantt-component';
+import { Phase } from '@sme.up/gantt-component';
+import { GanttRow } from '@sme.up/gantt-component';
+import { KupEventPayload } from '../../components';
+import { KupDataColumn, KupDataRow } from '../../managers/kup-data/kup-data-declarations';
+import { KupDataTableCell } from '../kup-data-table/kup-data-table-declarations';
+/**
+ * Props of the kup-gantt component.
+ * Used to export every prop in an object.
+ */
+export declare enum KupPlannerProps {
+  customStyle = "Custom style of the component.",
+  data = "Dataset containg the tasks list",
+  detailData = "Dataset containg the details list",
+  detailColorCol = "Column containing the detail color, in hex format",
+  detailColumns = "Columns containing informations displayed in the left box, near the gantt of details",
+  detailDates = "Columns containing detail duration, from (firstDate) to (secondDate)",
+  detailFilter = "Sets the detail's filter.",
+  detailHeight = "Height for detail gantt",
+  detailIdCol = "Column containing unique detail identifier",
+  detailNameCol = "Column containing detail name displayed",
+  detailPrevDates = "Columns containing forecast detail duration, from (firstDate) to (secondDate)",
+  detailInitialScrollX = "Sets the initial scroll X for the detail.",
+  detailInitialScrollY = "Sets the initial scroll Y for the detail.",
+  listCellWidth = "Total size of the cells inside to the left box, near the gantt",
+  maxWidth = "Max width for component",
+  phaseColorCol = "Column containing the phase color in hex format",
+  phaseColumns = "Columns containing informations displayed in the left box ,near the gantt of phases",
+  phaseColParDep = "Column containing the name of the parent phases",
+  phaseDates = "Columns containing phase duration, from (firstDate) to (secondDate)",
+  phaseIdCol = "Column containing unique phase identifier",
+  phaseNameCol = "Column containing phase name displayed",
+  phasePrevDates = "Columns containing forecast phase duration, from (firstDate) to (secondDate)",
+  readOnly = "When true, the two gantts are not interactable.",
+  showSecondaryDates = "Enable/disable display of secondary dates",
+  taskColumns = "Columns containing informations displayed in the left box, near the gantt",
+  taskDates = "Columns containing task duration, from (firstDate) to (secondDate)",
+  taskFilter = "Sets the task's filter.",
+  taskHeight = "Height for main gantt",
+  taskIdCol = "Column containing unique task identifier",
+  taskNameCol = "Column containing task name displayed",
+  taskPrevDates = "Columns containing forecast task duration, from (firstDate) to (secondDate)",
+  taskInitialScrollX = "Sets the initial scroll X for the task.",
+  taskInitialScrollY = "Sets the initial scroll Y for the task.",
+  titleMess = "Message displayed on top"
+}
+export declare enum KupPlannerTaskAction {
+  onTaskOpening = "onTaskOpening",
+  onTaskClosing = "onTaskClosing",
+  onClick = "onClick",
+  onResize = "onResize",
+  onRightClick = "onRightClick"
+}
+export interface KupPlannerEventPayload extends KupEventPayload {
+  value: GanttRow;
+  taskAction?: KupPlannerTaskAction;
+}
+export interface KupPlannerClickEventPayload extends KupPlannerEventPayload {
+  details: KupPlannerEventHandlerDetails;
+}
+export interface KupPlannerUnloadEventPayload extends KupEventPayload {
+  storedSettings: KupPlannerStoredSettings;
+}
+export interface KupPlannerEventHandlerDetails {
+  cell: KupDataTableCell;
+  column: KupDataColumn;
+  originalEvent: React.MouseEvent<Element, MouseEvent>;
+  row: KupDataRow;
+}
+export declare enum KupPlannerGanttRowType {
+  TASK = "task",
+  PHASE = "phase",
+  DETAIL = "detail"
+}
+export interface KupPlannerGanttTask extends GanttTask {
+  taskRowId: string;
+  taskRow: KupDataRow;
+  rowType: KupPlannerGanttRowType;
+}
+export interface KupPlannerDetail extends Detail {
+  rowType: KupPlannerGanttRowType;
+  detailRow: KupDataRow;
+}
+export interface KupPlannerPhase extends Phase {
+  taskRowId: string;
+  taskRow: KupDataRow;
+  phaseRowId: string;
+  phaseRow: KupDataRow;
+  rowType: KupPlannerGanttRowType;
+}
+export declare class KupPlannerLastOnChangeReceived {
+  private event;
+  private dateTime;
+  private threshold;
+  constructor(event: GanttRow, threshold?: number);
+  isEquivalent(newEvent: GanttRow): boolean;
+  resetDateTime(): void;
+}
+export declare const defaultStylingOptions: {
+  listCellWidth: string;
+  rowHeight: number;
+  barFill: number;
+  projectProgressColor: string;
+  projectProgressSelectedColor: string;
+  projectBackgroundColor: string;
+  projectBackgroundSelectedColor: string;
+  barProgressColor: string;
+  barProgressSelectedColor: string;
+  barBackgroundColor: string;
+  barBackgroundSelectedColor: string;
+};
+export interface KupPlannerDatesSanitized {
+  dateValues: string[];
+  secDateValues: string[];
+}
+export type KupPlannerViewMode = 'day' | 'week' | 'month' | 'year';
+export interface KupPlannerStoredSettings {
+  showSecondaryDates: boolean;
+  detailFilter: string;
+  detailInitialScrollX: number;
+  detailInitialScrollY: number;
+  taskFilter: string;
+  taskInitialScrollX: number;
+  taskInitialScrollY: number;
+  viewMode: KupPlannerViewMode;
+}

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

@@ -1,6 +1,6 @@
-import { KupDataCell } from '../../components';
-import { KupDataColumn, KupDataRow } from '../../managers/kup-data/kup-data-declarations';
-import { KupPlannerDatesSanitized } from './kup-planner-declarations';
-export declare function sanitizeAllDates(startDateCell: KupDataCell, endDateCell: KupDataCell, secStartDateCell?: KupDataCell, secEndDateCell?: KupDataCell): KupPlannerDatesSanitized;
-export declare function isAtLeastOneDateValid(startDateCell: KupDataCell, endDateCell: KupDataCell): boolean;
-export declare function getValuesToShow(row: KupDataRow, idCol: string, nameCol: string, dataColumns: KupDataColumn[], columns?: string[], customToValuesFunction?: () => string[]): string[];
+import { KupDataCell } from '../../components';
+import { KupDataColumn, KupDataRow } from '../../managers/kup-data/kup-data-declarations';
+import { KupPlannerDatesSanitized } from './kup-planner-declarations';
+export declare function sanitizeAllDates(startDateCell: KupDataCell, endDateCell: KupDataCell, secStartDateCell?: KupDataCell, secEndDateCell?: KupDataCell): KupPlannerDatesSanitized;
+export declare function isAtLeastOneDateValid(startDateCell: KupDataCell, endDateCell: KupDataCell): boolean;
+export declare function getValuesToShow(row: KupDataRow, idCol: string, nameCol: string, dataColumns: KupDataColumn[], columns?: string[], customToValuesFunction?: () => string[]): string[];

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

@@ -0,0 +1,13 @@
+import { KupState } from '../kup-state/kup-state';
+import { KupPlannerStoredSettings, KupPlannerViewMode } from './kup-planner-declarations';
+export declare class KupPlannerState implements KupState, KupPlannerStoredSettings {
+  showSecondaryDates: boolean;
+  detailFilter: string;
+  detailInitialScrollX: number;
+  detailInitialScrollY: number;
+  taskFilter: string;
+  taskInitialScrollX: number;
+  taskInitialScrollY: number;
+  viewMode: KupPlannerViewMode;
+  toDebugString(): string;
+}