@odoo/o-spreadsheet 16.5.0-alpha.10 → 16.5.0-alpha.11

package/dist/o-spreadsheet.d.ts

@@ -907,6 +907,15 @@ declare function colorToRGBA(color: Color): RGBA;
  *     27 => 'AB'
  */
 declare function numberToLetters(n: number): string;
+/**
+ * Convert a string (describing a column) to its number value.
+ *
+ * Examples:
+ *     'A' => 0
+ *     'Z' => 25
+ *     'AA' => 26
+ */
+declare function lettersToNumber(letters: string): number;
 /**
  * Convert a "XC" coordinate to cartesian coordinates.
  *
@@ -1002,6 +1011,21 @@ declare class UuidGenerator {
     uuidv4(): string;
 }
 
+/**
+ * Convert from a cartesian reference to a (possibly unbounded) Zone
+ *
+ * Examples:
+ *    "A1" ==> Top 0, Bottom 0, Left: 0, Right: 0
+ *    "B1:B3" ==> Top 0, Bottom 3, Left: 1, Right: 1
+ *    "B:B" ==> Top 0, Bottom undefined, Left: 1, Right: 1
+ *    "B2:B" ==> Top 1, Bottom undefined, Left: 1, Right: 1, hasHeader: 1
+ *    "Sheet1!A1" ==> Top 0, Bottom 0, Left: 0, Right: 0
+ *    "Sheet1!B1:B3" ==> Top 0, Bottom 3, Left: 1, Right: 1
+ *
+ * @param xc the string reference to convert
+ *
+ */
+declare function toUnboundedZone(xc: string): UnboundedZone;
 /**
  * Convert from a cartesian reference to a Zone.
  * Will return throw an error if given a unbounded zone (eg : A:A).
@@ -1070,6 +1094,7 @@ interface SelectionProcessor {
     selectAll(): DispatchResult;
     loopSelection(): DispatchResult;
     selectTableAroundSelection(): DispatchResult;
+    isListening(owner: unknown): boolean;
 }
 type SelectionStreamProcessor = SelectionProcessor & StatefulStream<SelectionEvent, AnchorZone>;
 
@@ -3470,7 +3495,6 @@ declare class ChartPlugin extends CorePlugin<ChartState> implements ChartState {
     getChartDefinition(figureId: UID): ChartDefinition;
     import(data: WorkbookData): void;
     export(data: WorkbookData): void;
-    exportForExcel(data: ExcelWorkbookData): void;
     /**
      * Add a figure with tag chart with the given id at the given position
      */
@@ -4051,7 +4075,7 @@ declare class SheetPlugin extends CorePlugin<SheetState> implements SheetState {
 
 declare class EvaluationPlugin extends UIPlugin {
     private config;
-    static getters: readonly ["evaluateFormula", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone"];
+    static getters: readonly ["evaluateFormula", "getCorrespondingFormulaCell", "getRangeFormattedValues", "getRangeValues", "getRangeFormats", "getEvaluatedCell", "getEvaluatedCells", "getEvaluatedCellsInZone"];
     private shouldRebuildDependenciesGraph;
     private evaluator;
     private compilationParams;
@@ -4082,7 +4106,7 @@ declare class EvaluationPlugin extends UIPlugin {
      * It could be the formula present in the cell itself or the
      * formula of the array formula that spreads to the cell
      */
-    private getCorrespondingFormulaCell;
+    getCorrespondingFormulaCell(position: CellPosition): FormulaCell | undefined;
     private getCompilationParameters;
 }
 
@@ -4127,6 +4151,7 @@ declare class EvaluationChartPlugin extends UIPlugin<EvaluationChartState> {
      *  - the default chart color if no other color is defined
      */
     getBackgroundOfSingleCellChart(chartBackground: Color | undefined, mainRange: Range | undefined): Color;
+    exportForExcel(data: ExcelWorkbookData): void;
 }
 
 declare class EvaluationConditionalFormatPlugin extends UIPlugin {
@@ -4837,7 +4862,7 @@ declare class FilterEvaluationPlugin extends UIPlugin {
  */
 declare class GridSelectionPlugin extends UIPlugin {
     static layers: LAYERS[];
-    static getters: readonly ["getActiveSheet", "getActiveSheetId", "getActiveCell", "getActiveCols", "getActiveRows", "getCurrentStyle", "getSelectedZones", "getSelectedZone", "getSelectedCells", "getStatisticFnResults", "getAggregate", "getSelectedFigureId", "getSelection", "getActivePosition", "getSheetPosition", "isSelected", "isSingleColSelected", "getElementsFromSelection", "tryGetActiveSheetId"];
+    static getters: readonly ["getActiveSheet", "getActiveSheetId", "getActiveCell", "getActiveCols", "getActiveRows", "getCurrentStyle", "getSelectedZones", "getSelectedZone", "getSelectedCells", "getStatisticFnResults", "getAggregate", "getSelectedFigureId", "getSelection", "getActivePosition", "getSheetPosition", "isSelected", "isSingleColSelected", "getElementsFromSelection", "tryGetActiveSheetId", "isGridSelectionActive"];
     private gridSelection;
     private selectedFigureId;
     private sheetsData;
@@ -4847,6 +4872,7 @@ declare class GridSelectionPlugin extends UIPlugin {
     allowDispatch(cmd: LocalCommand): CommandResult;
     private handleEvent;
     handle(cmd: Command): void;
+    isGridSelectionActive(): boolean;
     getActiveSheet(): Readonly<Sheet>;
     getActiveSheetId(): UID;
     tryGetActiveSheetId(): UID | undefined;
@@ -5172,51 +5198,34 @@ declare class SheetViewPlugin extends UIPlugin {
 type GetterNames<Plugin extends {
     getters: readonly string[];
 }> = Plugin["getters"][number];
-type SheetGetters = Pick<SheetPlugin, GetterNames<typeof SheetPlugin>>;
-type HeaderSizeGetters = Pick<HeaderSizePlugin, GetterNames<typeof HeaderSizePlugin>>;
-type HeaderVisibilityGetters = Pick<HeaderVisibilityPlugin, GetterNames<typeof HeaderVisibilityPlugin>>;
-type CellGetters = Pick<CellPlugin, GetterNames<typeof CellPlugin>>;
-type MergeGetters = Pick<MergePlugin, GetterNames<typeof MergePlugin>>;
-type BordersGetters = Pick<BordersPlugin, GetterNames<typeof BordersPlugin>>;
-type ChartGetters = Pick<ChartPlugin, GetterNames<typeof ChartPlugin>>;
-type ImageGetters = Pick<ImagePlugin, GetterNames<typeof ImagePlugin>>;
-type FigureGetters = Pick<FigurePlugin, GetterNames<typeof FigurePlugin>>;
+/**
+ * Extract getter methods from a plugin, based on its `getters` static array.
+ * @example
+ * class MyPlugin {
+ *   static getters = [
+ *     "getCell",
+ *     "getCellValue",
+ *   ] as const;
+ *   getCell() { ... }
+ *   getCellValue() { ... }
+ * }
+ * type MyPluginGetters = PluginGetters<typeof MyPlugin>;
+ * // MyPluginGetters is equivalent to:
+ * // {
+ * //   getCell: () => ...,
+ * //   getCellValue: () => ...,
+ * // }
+ */
+type PluginGetters<Plugin extends {
+    new (...args: unknown[]): any;
+    getters: readonly string[];
+}> = Pick<InstanceType<Plugin>, GetterNames<Plugin>>;
 type RangeAdapterGetters = Pick<RangeAdapter, GetterNames<typeof RangeAdapter>>;
-type ConditionalFormatGetters = Pick<ConditionalFormatPlugin, GetterNames<typeof ConditionalFormatPlugin>>;
-type LocalHistoryGetters = Pick<HistoryPlugin, GetterNames<typeof HistoryPlugin>>;
-type FiltersGetters = Pick<FiltersPlugin, GetterNames<typeof FiltersPlugin>>;
-type SettingsGetters = Pick<SettingsPlugin, GetterNames<typeof SettingsPlugin>>;
-type HeaderGroupingGetters = Pick<HeaderGroupingPlugin, GetterNames<typeof HeaderGroupingPlugin>>;
-type DataValidationGetters = Pick<DataValidationPlugin, GetterNames<typeof DataValidationPlugin>>;
-type CoreGetters = SheetGetters & HeaderSizeGetters & HeaderVisibilityGetters & CellGetters & MergeGetters & BordersGetters & ChartGetters & ImageGetters & ConditionalFormatGetters & FigureGetters & RangeAdapterGetters & FiltersGetters & SettingsGetters & HeaderGroupingGetters & DataValidationGetters;
-type AutofillGetters = Pick<AutofillPlugin, GetterNames<typeof AutofillPlugin>>;
-type AutomaticSumGetters = Pick<AutomaticSumPlugin, GetterNames<typeof AutomaticSumPlugin>>;
-type ClipboardGetters = Pick<ClipboardPlugin, GetterNames<typeof ClipboardPlugin>>;
-type EditionGetters = Pick<EditionPlugin, GetterNames<typeof EditionPlugin>>;
-type EvaluationGetters = Pick<EvaluationPlugin, GetterNames<typeof EvaluationPlugin>>;
-type EvaluationChartGetters = Pick<EvaluationChartPlugin, GetterNames<typeof EvaluationChartPlugin>>;
-type EvaluationConditionalFormatGetters = Pick<EvaluationConditionalFormatPlugin, GetterNames<typeof EvaluationConditionalFormatPlugin>>;
-type FindAndReplaceGetters = Pick<FindAndReplacePlugin, GetterNames<typeof FindAndReplacePlugin>>;
-type HeaderVisibilityIUIGetters = Pick<HeaderVisibilityUIPlugin, GetterNames<typeof HeaderVisibilityUIPlugin>>;
-type HighlightGetters = Pick<HighlightPlugin, GetterNames<typeof HighlightPlugin>>;
-type CustomColorsGetters = Pick<CustomColorsPlugin, GetterNames<typeof CustomColorsPlugin>>;
-type RendererGetters = Pick<RendererPlugin, GetterNames<typeof RendererPlugin>>;
-type SelectionGetters = Pick<GridSelectionPlugin, GetterNames<typeof GridSelectionPlugin>>;
-type SelectionInputGetters = Pick<SelectionInputsManagerPlugin, GetterNames<typeof SelectionInputsManagerPlugin>>;
-type CollaborativeGetters = Pick<CollaborativePlugin, GetterNames<typeof CollaborativePlugin>>;
-type SortGetters = Pick<SortPlugin, GetterNames<typeof SortPlugin>>;
-type UIOptionsGetters = Pick<UIOptionsPlugin, GetterNames<typeof UIOptionsPlugin>>;
-type SheetUIGetters = Pick<SheetUIPlugin, GetterNames<typeof SheetUIPlugin>>;
-type ViewportGetters = Pick<SheetViewPlugin, GetterNames<typeof SheetViewPlugin>>;
-type CellPopoverPluginGetters = Pick<CellPopoverPlugin, GetterNames<typeof CellPopoverPlugin>>;
-type FilterEvaluationGetters = Pick<FilterEvaluationPlugin, GetterNames<typeof FilterEvaluationPlugin>>;
-type SplitToColumnsGetters = Pick<SplitToColumnsPlugin, GetterNames<typeof SplitToColumnsPlugin>>;
-type UIRowSizeGetters = Pick<UIRowSizePlugin, GetterNames<typeof UIRowSizePlugin>>;
-type EvaluationDataValidationPluginGetters = Pick<EvaluationDataValidationPlugin, GetterNames<typeof EvaluationDataValidationPlugin>>;
+type CoreGetters = PluginGetters<typeof SheetPlugin> & PluginGetters<typeof HeaderSizePlugin> & PluginGetters<typeof HeaderVisibilityPlugin> & PluginGetters<typeof CellPlugin> & PluginGetters<typeof MergePlugin> & PluginGetters<typeof BordersPlugin> & PluginGetters<typeof ChartPlugin> & PluginGetters<typeof ImagePlugin> & PluginGetters<typeof FigurePlugin> & RangeAdapterGetters & PluginGetters<typeof ConditionalFormatPlugin> & PluginGetters<typeof FiltersPlugin> & PluginGetters<typeof SettingsPlugin> & PluginGetters<typeof HeaderGroupingPlugin> & PluginGetters<typeof DataValidationPlugin>;
 type Getters = {
     isReadonly: () => boolean;
     isDashboard: () => boolean;
-} & LocalHistoryGetters & CoreGetters & AutofillGetters & AutomaticSumGetters & ClipboardGetters & EditionGetters & EvaluationGetters & EvaluationChartGetters & EvaluationConditionalFormatGetters & FindAndReplaceGetters & HighlightGetters & CustomColorsGetters & RendererGetters & SelectionGetters & SelectionInputGetters & CollaborativeGetters & SortGetters & UIOptionsGetters & SheetUIGetters & ViewportGetters & CellPopoverPluginGetters & FilterEvaluationGetters & HeaderVisibilityIUIGetters & SplitToColumnsGetters & UIRowSizeGetters & EvaluationDataValidationPluginGetters;
+} & CoreGetters & PluginGetters<typeof AutofillPlugin> & PluginGetters<typeof AutomaticSumPlugin> & PluginGetters<typeof HistoryPlugin> & PluginGetters<typeof ClipboardPlugin> & PluginGetters<typeof EditionPlugin> & PluginGetters<typeof EvaluationPlugin> & PluginGetters<typeof EvaluationChartPlugin> & PluginGetters<typeof EvaluationConditionalFormatPlugin> & PluginGetters<typeof FindAndReplacePlugin> & PluginGetters<typeof HeaderVisibilityUIPlugin> & PluginGetters<typeof HighlightPlugin> & PluginGetters<typeof CustomColorsPlugin> & PluginGetters<typeof AutomaticSumPlugin> & PluginGetters<typeof RendererPlugin> & PluginGetters<typeof GridSelectionPlugin> & PluginGetters<typeof SelectionInputsManagerPlugin> & PluginGetters<typeof CollaborativePlugin> & PluginGetters<typeof SortPlugin> & PluginGetters<typeof UIOptionsPlugin> & PluginGetters<typeof SheetUIPlugin> & PluginGetters<typeof SheetViewPlugin> & PluginGetters<typeof CellPopoverPlugin> & PluginGetters<typeof FilterEvaluationPlugin> & PluginGetters<typeof SplitToColumnsPlugin> & PluginGetters<typeof UIRowSizePlugin> & PluginGetters<typeof EvaluationDataValidationPlugin>;
 
 interface HistoryChange {
     root: any;
@@ -5870,8 +5879,10 @@ interface AutofillRule {
     sequence: number;
 }
 
+declare function transformRangeData(range: RangeData, executed: CoreCommand): RangeData | undefined;
+
 interface Props$B {
-    figure: Figure;
+    figureId: UID;
 }
 declare class ChartJsComponent extends Component<Props$B, SpreadsheetChildEnv> {
     static template: string;
@@ -5886,38 +5897,14 @@ declare class ChartJsComponent extends Component<Props$B, SpreadsheetChildEnv> {
 }
 
 interface Props$A {
-    figure: Figure;
+    figureId: UID;
 }
 declare class ScorecardChart extends Component<Props$A, SpreadsheetChildEnv> {
     static template: string;
-    private ctx;
+    private canvas;
     get runtime(): ScorecardChartRuntime;
-    get title(): string;
-    get keyValue(): string;
-    get baseline(): string;
-    get baselineDescr(): string;
-    get baselineArrowDirection(): BaselineArrowDirection;
-    get backgroundColor(): Color;
-    get primaryFontColor(): Color;
-    get secondaryFontColor(): "#525252" | "#C8C8C8";
-    get figure(): Figure;
-    get chartStyle(): string;
-    get chartContentStyle(): string;
-    get chartPadding(): number;
-    translate(term: any): string;
-    getTextStyles(): {
-        titleStyle: string;
-        keyStyle: string;
-        baselineStyle: string;
-        baselineValueStyle: string;
-        baselineDescrStyle: string;
-    };
-    /** Return an CSS style string corresponding to the given arguments */
-    private getTextStyle;
-    /** Get the height of the chart minus all the vertical paddings */
-    private getDrawableHeight;
-    /** Return the element with he widest text in the chart */
-    private getWidestElement;
+    setup(): void;
+    private createChart;
 }
 
 type MenuItemOrSeparator = Action | "separator";
@@ -6013,7 +6000,7 @@ declare class FigureComponent extends Component<Props$y, SpreadsheetChildEnv> {
 }
 
 interface Props$x {
-    figure: Figure;
+    figureId: UID;
     onFigureDeleted: () => void;
 }
 declare class ChartFigure extends Component<Props$x, SpreadsheetChildEnv> {
@@ -6754,6 +6741,14 @@ declare const formatNumberDate: ActionSpec;
 declare const formatNumberTime: ActionSpec;
 declare const formatNumberDateTime: ActionSpec;
 declare const formatNumberDuration: ActionSpec;
+declare const moreFormats: ActionSpec;
+declare const formatNumberFullDateTime: ActionSpec;
+declare const formatNumberFullWeekDayAndMonth: ActionSpec;
+declare const formatNumberDayAndFullMonth: ActionSpec;
+declare const formatNumberShortWeekDay: ActionSpec;
+declare const formatNumberDayAndShortMonth: ActionSpec;
+declare const formatNumberFullMonth: ActionSpec;
+declare const formatNumberShortMonth: ActionSpec;
 declare const incraseDecimalPlaces: ActionSpec;
 declare const decraseDecimalPlaces: ActionSpec;
 declare const formatBold: ActionSpec;
@@ -6802,9 +6797,16 @@ declare const ACTION_FORMAT_formatNumberCurrency: typeof formatNumberCurrency;
 declare const ACTION_FORMAT_formatNumberCurrencyRounded: typeof formatNumberCurrencyRounded;
 declare const ACTION_FORMAT_formatNumberDate: typeof formatNumberDate;
 declare const ACTION_FORMAT_formatNumberDateTime: typeof formatNumberDateTime;
+declare const ACTION_FORMAT_formatNumberDayAndFullMonth: typeof formatNumberDayAndFullMonth;
+declare const ACTION_FORMAT_formatNumberDayAndShortMonth: typeof formatNumberDayAndShortMonth;
 declare const ACTION_FORMAT_formatNumberDuration: typeof formatNumberDuration;
+declare const ACTION_FORMAT_formatNumberFullDateTime: typeof formatNumberFullDateTime;
+declare const ACTION_FORMAT_formatNumberFullMonth: typeof formatNumberFullMonth;
+declare const ACTION_FORMAT_formatNumberFullWeekDayAndMonth: typeof formatNumberFullWeekDayAndMonth;
 declare const ACTION_FORMAT_formatNumberNumber: typeof formatNumberNumber;
 declare const ACTION_FORMAT_formatNumberPercent: typeof formatNumberPercent;
+declare const ACTION_FORMAT_formatNumberShortMonth: typeof formatNumberShortMonth;
+declare const ACTION_FORMAT_formatNumberShortWeekDay: typeof formatNumberShortWeekDay;
 declare const ACTION_FORMAT_formatNumberTime: typeof formatNumberTime;
 declare const ACTION_FORMAT_formatPercent: typeof formatPercent;
 declare const ACTION_FORMAT_formatStrikethrough: typeof formatStrikethrough;
@@ -6815,6 +6817,7 @@ declare const ACTION_FORMAT_formatWrappingIcon: typeof formatWrappingIcon;
 declare const ACTION_FORMAT_formatWrappingOverflow: typeof formatWrappingOverflow;
 declare const ACTION_FORMAT_formatWrappingWrap: typeof formatWrappingWrap;
 declare const ACTION_FORMAT_incraseDecimalPlaces: typeof incraseDecimalPlaces;
+declare const ACTION_FORMAT_moreFormats: typeof moreFormats;
 declare const ACTION_FORMAT_textColor: typeof textColor;
 declare namespace ACTION_FORMAT {
   export {
@@ -6840,9 +6843,16 @@ declare namespace ACTION_FORMAT {
     ACTION_FORMAT_formatNumberCurrencyRounded as formatNumberCurrencyRounded,
     ACTION_FORMAT_formatNumberDate as formatNumberDate,
     ACTION_FORMAT_formatNumberDateTime as formatNumberDateTime,
+    ACTION_FORMAT_formatNumberDayAndFullMonth as formatNumberDayAndFullMonth,
+    ACTION_FORMAT_formatNumberDayAndShortMonth as formatNumberDayAndShortMonth,
     ACTION_FORMAT_formatNumberDuration as formatNumberDuration,
+    ACTION_FORMAT_formatNumberFullDateTime as formatNumberFullDateTime,
+    ACTION_FORMAT_formatNumberFullMonth as formatNumberFullMonth,
+    ACTION_FORMAT_formatNumberFullWeekDayAndMonth as formatNumberFullWeekDayAndMonth,
     ACTION_FORMAT_formatNumberNumber as formatNumberNumber,
     ACTION_FORMAT_formatNumberPercent as formatNumberPercent,
+    ACTION_FORMAT_formatNumberShortMonth as formatNumberShortMonth,
+    ACTION_FORMAT_formatNumberShortWeekDay as formatNumberShortWeekDay,
     ACTION_FORMAT_formatNumberTime as formatNumberTime,
     ACTION_FORMAT_formatPercent as formatPercent,
     ACTION_FORMAT_formatStrikethrough as formatStrikethrough,
@@ -6853,6 +6863,7 @@ declare namespace ACTION_FORMAT {
     ACTION_FORMAT_formatWrappingOverflow as formatWrappingOverflow,
     ACTION_FORMAT_formatWrappingWrap as formatWrappingWrap,
     ACTION_FORMAT_incraseDecimalPlaces as incraseDecimalPlaces,
+    ACTION_FORMAT_moreFormats as moreFormats,
     ACTION_FORMAT_textColor as textColor,
   };
 }
@@ -7814,8 +7825,10 @@ declare const helpers: {
     toString: typeof toString;
     toXC: typeof toXC;
     toZone: typeof toZone;
+    toUnboundedZone: typeof toUnboundedZone;
     toCartesian: typeof toCartesian;
     numberToLetters: typeof numberToLetters;
+    lettersToNumber: typeof lettersToNumber;
     UuidGenerator: typeof UuidGenerator;
     formatValue: typeof formatValue;
     createCurrencyFormat: typeof createCurrencyFormat;
@@ -7837,6 +7850,7 @@ declare const helpers: {
     genericRepeat: typeof genericRepeat;
     createAction: typeof createAction;
     createActions: typeof createActions;
+    transformRangeData: typeof transformRangeData;
 };
 declare const links: {
     isMarkdownLink: typeof isMarkdownLink;
@@ -7862,6 +7876,7 @@ declare const components: {
     ScorecardChartDesignPanel: typeof ScorecardChartDesignPanel;
     FigureComponent: typeof FigureComponent;
     Menu: typeof Menu;
+    SelectionInput: typeof SelectionInput;
 };
 declare const hooks: {
     useDragAndDropListItems: typeof useDragAndDropListItems;