@univerjs/sheets-ui 0.2.2 → 0.2.4-alpha.0

package/lib/types/services/selection/selection-render.service.d.ts

@@ -1,216 +1,32 @@
-import { IInterceptor, IRange, IRangeWithCoord, ISelection, ISelectionCell, ISelectionCellWithMergeInfo, Nullable, InterceptorManager, RANGE_TYPE, ThemeService } from '@univerjs/core';
-import { IMouseEvent, IPointerEvent, Scene, SpreadsheetSkeleton, Viewport, IRenderManagerService, ScrollTimerType } from '@univerjs/engine-render';
-import { ISelectionStyle, ISelectionWithCoordAndStyle, ISelectionWithStyle } from '@univerjs/sheets';
+import { Workbook, ICommandService, IContextService, ILogService, Injector, ThemeService } from '@univerjs/core';
+import { IRenderContext, IRenderModule, IRenderManagerService } from '@univerjs/engine-render';
+import { SheetsSelectionsService } from '@univerjs/sheets';
 import { IShortcutService } from '@univerjs/ui';
-import { Injector } from '@wendellhu/redi';
-import { Observable } from 'rxjs';
-import { SelectionControl as SelectionShape } from './selection-shape';
+import { SheetSkeletonManagerService } from '../sheet-skeleton-manager.service';
+import { BaseSelectionRenderService } from './base-selection-render.service';
 
-export interface IControlFillConfig {
-    oldRange: IRange;
-    newRange: IRange;
-}
-export interface ISelectionRenderService {
-    readonly selectionMoveEnd$: Observable<ISelectionWithCoordAndStyle[]>;
-    readonly controlFillConfig$: Observable<IControlFillConfig | null>;
-    readonly selectionMoving$: Observable<ISelectionWithCoordAndStyle[]>;
-    readonly selectionMoveStart$: Observable<ISelectionWithCoordAndStyle[]>;
-    readonly usable$: Observable<boolean>;
-    interceptor: InterceptorManager<{
-        RANGE_MOVE_PERMISSION_CHECK: IInterceptor<boolean, null>;
-        RANGE_FILL_PERMISSION_CHECK: IInterceptor<boolean, {
-            x: number;
-            y: number;
-            skeleton: SpreadsheetSkeleton;
-            scene: Scene;
-        }>;
-    }>;
-    enableHeaderHighlight(): void;
-    disableHeaderHighlight(): void;
-    enableDetectMergedCell(): void;
-    disableDetectMergedCell(): void;
-    setStyle(style: ISelectionStyle): void;
-    resetStyle(): void;
-    enableSelection(): void;
-    disableSelection(): void;
-    enableShowPrevious(): void;
-    disableShowPrevious(): void;
-    enableRemainLast(): void;
-    disableRemainLast(): void;
-    enableSkipRemainLast(): void;
-    disableSkipRemainLast(): void;
-    addSelectionControlBySelectionData(data: ISelectionWithCoordAndStyle): void;
-    updateControlForCurrentByRangeData(selections: ISelectionWithCoordAndStyle[]): void;
-    changeRuntime(skeleton: Nullable<SpreadsheetSkeleton>, scene: Nullable<Scene>, viewport?: Viewport): void;
-    /** @deprecated This should not be provided by the selection render service. */
-    getViewPort(): Viewport;
-    getSelectionControls(): SelectionShape[];
-    getActiveSelections(): Nullable<ISelection[]>;
-    getActiveRange(): Nullable<IRange>;
-    getActiveSelectionControl(): Nullable<SelectionShape>;
-    getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[];
-    attachSelectionWithCoord(selectionWithStyle: ISelectionWithStyle): ISelectionWithCoordAndStyle;
-    attachRangeWithCoord(range: IRange): Nullable<IRangeWithCoord>;
-    attachPrimaryWithCoord(primary: Nullable<ISelectionCell>): Nullable<ISelectionCellWithMergeInfo>;
-    getSelectionCellByPosition(x: number, y: number): Nullable<ISelectionCellWithMergeInfo>;
-    eventTrigger(evt: IPointerEvent | IMouseEvent, zIndex: number, rangeType: RANGE_TYPE, viewport?: Viewport, scrollTimerType?: ScrollTimerType): void;
-    reset(): void;
-    refreshSelectionMoveStart(): void;
-    enableSingleSelection(): void;
-    disableSingleSelection(): void;
-}
 /**
- * TODO 注册 selection 拦截，可能在有公式 ArrayObject 时，fx 公式栏显示不同
- *
- * SelectionRenderService 维护 viewModel 数据 list，action 也是修改这一层数据，obs 监听到数据变动后，自动刷新（control 仍然可以持有数据）
- *
- * This service is related to the drawing of the selection.
- * By modifying the properties of the service,
- * you can adjust the style and performance of each selection area.
- * This service is used in conjunction with the SelectionManagerService
- * to implement functions related to the selection area in univer.
- *
- * @todo Refactor it to RenderController.
+ * This services controls rendering of normal selections in a render unit.
+ * The normal selections would also be used by Auto Fill and Copy features.
  */
-export declare const RANGE_MOVE_PERMISSION_CHECK: IInterceptor<boolean, null>;
-export declare const RANGE_FILL_PERMISSION_CHECK: IInterceptor<boolean, {
-    x: number;
-    y: number;
-    skeleton: SpreadsheetSkeleton;
-    scene: Scene;
-}>;
-export declare class SelectionRenderService implements ISelectionRenderService {
-    private readonly _themeService;
-    private readonly _shortcutService;
-    private readonly _renderManagerService;
-    private readonly _injector;
-    hasSelection: boolean;
-    private _pointerdownSub;
-    private _mainScenePointerUpSub;
-    private _scenePointerMoveSub;
-    private _scenePointerUpSub;
-    private _controlFillConfig$;
-    readonly controlFillConfig$: Observable<IControlFillConfig | null>;
-    private _selectionControls;
-    private _startSelectionRange;
-    private _startOffsetX;
-    private _startOffsetY;
-    private _scrollTimer;
-    private _skeleton;
-    private _scene;
-    private _isHeaderHighlight;
-    private _isDetectMergedCell;
-    private _selectionStyle;
-    private _isSelectionEnabled;
-    private _isShowPreviousEnable;
-    private _isRemainLastEnable;
-    private _isSkipRemainLastEnable;
-    private _isSingleSelection;
-    private readonly _selectionMoveEnd$;
-    readonly selectionMoveEnd$: Observable<ISelectionWithCoordAndStyle[]>;
-    private readonly _selectionMoving$;
-    /**
-     * Triggered during the drawing of the selection area.
-     */
-    readonly selectionMoving$: Observable<ISelectionWithCoordAndStyle[]>;
-    private readonly _selectionMoveStart$;
-    /**
-     * Triggered during the start draw the selection area.
-     */
-    readonly selectionMoveStart$: Observable<ISelectionWithCoordAndStyle[]>;
-    private _activeViewport;
-    /**
-     * This service relies on the scene and skeleton to work
-     * Use usable$ to check if this service works
-     */
-    private readonly _usable$;
-    readonly usable$: Observable<boolean>;
-    interceptor: InterceptorManager<{
-        RANGE_MOVE_PERMISSION_CHECK: IInterceptor<boolean, null>;
-        RANGE_FILL_PERMISSION_CHECK: IInterceptor<boolean, {
-            x: number;
-            y: number;
-            skeleton: SpreadsheetSkeleton;
-            scene: Scene;
-        }>;
-    }>;
-    constructor(_themeService: ThemeService, _shortcutService: IShortcutService, _renderManagerService: IRenderManagerService, _injector: Injector);
-    enableHeaderHighlight(): void;
-    disableHeaderHighlight(): void;
-    enableDetectMergedCell(): void;
-    disableDetectMergedCell(): void;
-    setStyle(style: ISelectionStyle): void;
-    resetStyle(): void;
-    enableSelection(): void;
-    disableSelection(): void;
-    enableShowPrevious(): void;
-    disableShowPrevious(): void;
-    enableRemainLast(): void;
-    disableRemainLast(): void;
-    enableSkipRemainLast(): void;
-    disableSkipRemainLast(): void;
-    enableSingleSelection(): void;
-    disableSingleSelection(): void;
-    getViewPort(): Viewport;
-    /**
-     * add a selection
-     * @param data
-     */
-    addSelectionControlBySelectionData(data: ISelectionWithCoordAndStyle): void;
-    updateControlForCurrentByRangeData(selections: ISelectionWithCoordAndStyle[]): void;
-    refreshSelectionMoveStart(): void;
-    changeRuntime(skeleton: Nullable<SpreadsheetSkeleton>, scene: Nullable<Scene>, viewport?: Viewport): void;
-    getSelectionDataWithStyle(): ISelectionWithCoordAndStyle[];
-    getSelectionControls(): SelectionShape[];
-    private _clearSelectionControls;
-    private _getFreeze;
-    private _getViewportByCell;
-    /**
-     * Returns the list of active ranges in the active sheet or null if there are no active ranges.
-     * If there is a single range selected, this behaves as a getActiveRange() call.
-     *
-     * @returns
-     */
-    getActiveSelections(): Nullable<ISelection[]>;
-    /**
-     * Returns the selected range in the active sheet, or null if there is no active range. If multiple ranges are selected this method returns only the last selected range.
-     * TODO: 默认最后一个选区为当前激活选区，或者当前激活单元格所在选区为激活选区
-     * @returns
-     */
-    getActiveRange(): Nullable<IRange>;
-    /**
-     * get active selection control
-     * @returns
-     */
-    getActiveSelectionControl(): Nullable<SelectionShape>;
-    endSelection(): void;
-    /**
-     * first, clear All selection controls
-     * then unsubscribe all events
-     */
-    reset(): void;
-    resetAndEndSelection(): void;
-    /**
-     *
-     * @param evt component point event
-     * @param style selection style, Styles for user-customized selectors
-     * @param zIndex Stacking order of the selection object
-     * @param rangeType Determines whether the selection is made normally according to the range or by rows and columns
-     */
-    eventTrigger(evt: IPointerEvent | IMouseEvent, zIndex?: number, rangeType?: RANGE_TYPE, viewport?: Viewport, scrollTimerType?: ScrollTimerType): false | undefined;
-    attachSelectionWithCoord(selectionWithStyle: ISelectionWithStyle): ISelectionWithCoordAndStyle;
-    attachRangeWithCoord(range: IRange): Nullable<IRangeWithCoord>;
-    attachPrimaryWithCoord(primary: Nullable<ISelectionCell>): Nullable<ISelectionCellWithMergeInfo>;
-    getSelectionCellByPosition(x: number, y: number): Nullable<ISelectionCellWithMergeInfo>;
-    /**
-     * When mousedown and mouseup need to go to the coordination and undo stack, when mousemove does not need to go to the coordination and undo stack
-     */
-    private _moving;
-    private _endSelection;
-    private _addCancelObserver;
-    private _getSelectedRangeWithMerge;
+export declare class SheetSelectionRenderService extends BaseSelectionRenderService implements IRenderModule {
+    private readonly _context;
+    private readonly _logService;
+    private readonly _commandService;
+    private readonly _contextService;
+    private readonly _sheetSkeletonManagerService;
+    private readonly _workbookSelections;
+    private _renderDisposable;
+    constructor(_context: IRenderContext<Workbook>, injector: Injector, themeService: ThemeService, shortcutService: IShortcutService, renderManagerService: IRenderManagerService, selectionManagerService: SheetsSelectionsService, _logService: ILogService, _commandService: ICommandService, _contextService: IContextService, _sheetSkeletonManagerService: SheetSkeletonManagerService);
+    private _init;
+    private _initEventListeners;
+    private _initThemeChangeListener;
+    private _refreshSelection;
+    private _normalSelectionDisabled;
+    private _initSelectionChangeListener;
+    private _initUserActionSyncListener;
+    private _updateSelections;
+    private _initSkeletonChangeListener;
+    private _getActiveViewport;
+    private _getSheetObject;
 }
-/**
- * @deprecated Should be refactored to RenderUnit.
- */
-export declare const ISelectionRenderService: import('@wendellhu/redi').IdentifierDecorator<SelectionRenderService>;

package/lib/types/services/selection/selection-shape-extension.d.ts

@@ -1,6 +1,5 @@
-import { IRangeWithCoord, ThemeService } from '@univerjs/core';
+import { Injector, IRangeWithCoord, ThemeService } from '@univerjs/core';
 import { Scene, SpreadsheetSkeleton } from '@univerjs/engine-render';
-import { Injector } from '@wendellhu/redi';
 import { SelectionControl } from './selection-shape';
 
 export interface ISelectionShapeTargetSelection {
@@ -16,6 +15,7 @@ export declare class SelectionShapeExtension {
     private _skeleton;
     private _scene;
     private readonly _themeService;
+    /** @deprecated injection in extensions should be strictly limited. */
     private readonly _injector;
     private _startOffsetX;
     private _startOffsetY;
@@ -31,7 +31,9 @@ export declare class SelectionShapeExtension {
     private _targetSelection;
     private _isInMergeState;
     private _fillControlColors;
-    constructor(_control: SelectionControl, _skeleton: SpreadsheetSkeleton, _scene: Scene, _themeService: ThemeService, _injector: Injector);
+    constructor(_control: SelectionControl, _skeleton: SpreadsheetSkeleton, _scene: Scene, _themeService: ThemeService, 
+    /** @deprecated injection in extensions should be strictly limited. */
+    _injector: Injector);
     get isHelperSelection(): boolean;
     dispose(): void;
     private _getFreeze;

package/lib/types/services/selection/selection-shape.d.ts

@@ -80,9 +80,9 @@ export declare class SelectionControl extends Disposable {
     protected _widgetRects: Rect[];
     private _dispose$;
     readonly dispose$: import('rxjs').Observable<SelectionControl>;
-    readonly selectionMoving$: Subject<Nullable<IRangeWithCoord>>;
-    readonly selectionMoved$: Subject<Nullable<IRangeWithCoord>>;
-    readonly selectionScaling$: Subject<Nullable<IRangeWithCoord>>;
+    readonly selectionMoving$: Subject<IRangeWithCoord>;
+    readonly selectionMoved$: Subject<IRangeWithCoord>;
+    readonly selectionScaling$: Subject<IRangeWithCoord>;
     readonly selectionScaled$: Subject<Nullable<IRangeWithCoord>>;
     readonly selectionFilling$: Subject<Nullable<IRangeWithCoord>>;
     private readonly _selectionFilled$;
@@ -130,8 +130,6 @@ export declare class SelectionControl extends Disposable {
     get columnHeaderHeight(): number;
     set columnHeaderHeight(height: number);
     setEvent(state: boolean): void;
-    enableHeaderHighlight(): void;
-    disableHeaderHighlight(): void;
     refreshSelectionFilled(val: IRangeWithCoord): void;
     updateStyle(style: ISelectionStyle): void;
     updateRange(range: IRangeWithCoord): void;

package/lib/types/services/selection/util.d.ts

@@ -0,0 +1,6 @@
+import { ISelectionCell, ISelectionCellWithMergeInfo } from '@univerjs/core';
+import { SpreadsheetSkeleton } from '@univerjs/engine-render';
+import { ISelectionWithCoordAndStyle, ISelectionWithStyle } from '@univerjs/sheets';
+
+export declare function attachSelectionWithCoord(selection: ISelectionWithStyle, skeleton: SpreadsheetSkeleton): ISelectionWithCoordAndStyle;
+export declare function attachPrimaryWithCoord(primary: ISelectionCell, skeleton: SpreadsheetSkeleton): ISelectionCellWithMergeInfo;

package/lib/types/services/sheet-bar/sheet-bar.service.d.ts

@@ -1,5 +1,4 @@
-import { Disposable } from '@univerjs/core';
-import { IDisposable } from '@wendellhu/redi';
+import { Disposable, IDisposable } from '@univerjs/core';
 import { Observable } from 'rxjs';
 import { IScrollState } from '../../views/sheet-bar/sheet-bar-tabs/utils/slide-tab-bar';
 
@@ -20,7 +19,7 @@ export interface ISheetBarService {
     triggerSheetBarMenu(): void;
     registerSheetBarMenuHandler(handler: ISheetBarMenuHandler): IDisposable;
 }
-export declare const ISheetBarService: import('@wendellhu/redi').IdentifierDecorator<ISheetBarService>;
+export declare const ISheetBarService: import('@univerjs/core').IdentifierDecorator<ISheetBarService>;
 export declare class SheetBarService extends Disposable implements ISheetBarService {
     readonly renameId$: Observable<string>;
     readonly removeId$: Observable<string>;

package/lib/types/services/sheet-skeleton-manager.service.d.ts

@@ -1,6 +1,5 @@
-import { Disposable, Nullable, Workbook } from '@univerjs/core';
+import { IRange, IRangeWithCoord, Nullable, Workbook, Disposable, Injector } from '@univerjs/core';
 import { IRenderContext, IRenderModule, SpreadsheetSkeleton } from '@univerjs/engine-render';
-import { Injector } from '@wendellhu/redi';
 
 export interface ISheetSkeletonManagerParam {
     unitId?: string;
@@ -37,9 +36,9 @@ export declare class SheetSkeletonManagerService extends Disposable implements I
     readonly currentSkeletonBefore$: import('rxjs').Observable<Nullable<ISheetSkeletonManagerParam>>;
     constructor(_context: IRenderContext<Workbook>, _injector: Injector);
     private _initRemoveSheet;
-    getCurrentSkeleton(): SpreadsheetSkeleton;
-    /** @deprecated */
+    getCurrentSkeleton(): Nullable<SpreadsheetSkeleton>;
     getCurrent(): Nullable<ISheetSkeletonManagerParam>;
+    getWorksheetSkeleton(sheetId: string): Nullable<ISheetSkeletonManagerParam>;
     /**
      * unitId is never read?
      */
@@ -51,6 +50,9 @@ export declare class SheetSkeletonManagerService extends Disposable implements I
     makeDirty(searchParm: ISheetSkeletonManagerSearch, state?: boolean): void;
     getOrCreateSkeleton(searchParam: ISheetSkeletonManagerSearch): SpreadsheetSkeleton | undefined;
     disposeSkeleton(searchParm: ISheetSkeletonManagerSearch): void;
+    /** @deprecated Use function `attachRangeWithCoord` instead.  */
+    attachRangeWithCoord(range: IRange): Nullable<IRangeWithCoord>;
     private _getSkeleton;
     private _buildSkeleton;
 }
+export declare function attachRangeWithCoord(skeleton: SpreadsheetSkeleton, range: IRange): IRangeWithCoord;

package/lib/types/services/sheets-render.service.d.ts

@@ -1,6 +1,5 @@
-import { IContextService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
+import { IDisposable, IContextService, IUniverInstanceService, RxDisposable } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
-import { IDisposable } from '@wendellhu/redi';
 
 /**
  * This controller is responsible for managing units of a specific kind to be rendered on the canvas.

package/lib/types/services/shortcut-experience.service.d.ts

@@ -1,6 +1,5 @@
-import { ISelection, ITextRangeParam, Nullable, IUniverInstanceService, LocaleService } from '@univerjs/core';
+import { IDisposable, ISelection, ITextRangeParam, Nullable, IUniverInstanceService, LocaleService } from '@univerjs/core';
 import { KeyCode } from '@univerjs/ui';
-import { IDisposable } from '@wendellhu/redi';
 
 export interface IShortcutExperienceSearch {
     unitId: string;
@@ -14,6 +13,8 @@ export interface IShortcutExperienceParam extends IShortcutExperienceSearch {
 /**
  * This service is prepared for shortcut experience optimization,
  * including the combined use of enter and tab, the highlighting experience of formulas in the editor, and so on.
+ *
+ * @deprecated this class looks weired
  */
 export declare class ShortcutExperienceService implements IDisposable {
     private readonly _univerInstanceService;

package/lib/types/services/status-bar.service.d.ts

@@ -1,6 +1,5 @@
-import { Nullable } from '@univerjs/core';
+import { IDisposable, Nullable } from '@univerjs/core';
 import { IFunctionNames } from '@univerjs/engine-formula';
-import { IDisposable } from '@wendellhu/redi';
 import { Observable } from 'rxjs';
 
 export interface IStatusBarService {
@@ -31,4 +30,4 @@ export declare class StatusBarService implements IStatusBarService, IDisposable
     getFunctions(): Readonly<IStatusBarFunction[]>;
     addFunctions(functions: IStatusBarFunction[]): void;
 }
-export declare const IStatusBarService: import('@wendellhu/redi').IdentifierDecorator<StatusBarService>;
+export declare const IStatusBarService: import('@univerjs/core').IdentifierDecorator<StatusBarService>;

package/lib/types/services/utils/selection-util.d.ts

@@ -0,0 +1,4 @@
+import { ThemeService } from '@univerjs/core';
+import { ISelectionStyle } from '@univerjs/sheets';
+
+export declare function createCopyPasteSelectionStyle(themeService: ThemeService): ISelectionStyle;

package/lib/types/sheets-ui-plugin.d.ts

@@ -1,5 +1,4 @@
-import { IUniverInstanceService, Plugin, UniverInstanceType } from '@univerjs/core';
-import { Injector } from '@wendellhu/redi';
+import { Injector, IUniverInstanceService, Plugin, UniverInstanceType } from '@univerjs/core';
 import { IRenderManagerService } from '@univerjs/engine-render';
 import { IUniverSheetsUIConfig } from './controllers/sheet-ui.controller';