@univerjs/engine-render 0.6.0 → 0.6.1-nightly.202502221605

package/lib/types/components/sheets/index.d.ts

@@ -21,3 +21,4 @@ export * from './row-header';
 export * from './sheet-component';
 export * from './sheet.render-skeleton';
 export * from './spreadsheet';
+export * from './watermark';

package/lib/types/components/sheets/watermark/index.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './type';
+export * from './util';
+export * from './watermark-layer';
+export declare const UNIVER_WATERMARK_STORAGE_KEY = "UNIVER_WATERMARK_STORAGE_KEY";
+export declare const UNIVER_WATERMARK_LAYER_INDEX = 10;

package/lib/types/components/sheets/watermark/type.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Copyright 2023-present DreamNum Co., Ltd.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export declare enum IWatermarkTypeEnum {
+    UserInfo = "userInfo",
+    Text = "text",
+    Image = "image"
+}
+export interface IGeneralWatermarkConfig {
+    x: number;
+    y: number;
+    repeat: boolean;
+    spacingX: number;
+    spacingY: number;
+    rotate: number;
+    opacity: number;
+}
+export interface ITextWatermarkConfig extends IGeneralWatermarkConfig {
+    content?: string;
+    fontSize: number;
+    color: string;
+    bold: boolean;
+    italic: boolean;
+    direction: 'ltr' | 'rtl' | 'inherit';
+}
+export interface IImageWatermarkConfig extends IGeneralWatermarkConfig {
+    url: string;
+    width: number;
+    height: number;
+    maintainAspectRatio: boolean;
+    originRatio: number;
+}
+export interface IUserInfoWatermarkConfig extends IGeneralWatermarkConfig, Omit<ITextWatermarkConfig, 'content'> {
+    name: boolean;
+    email: boolean;
+    phone: boolean;
+    uid: boolean;
+}
+export interface IWatermarkConfig {
+    text?: ITextWatermarkConfig;
+    image?: IImageWatermarkConfig;
+    userInfo?: IUserInfoWatermarkConfig;
+}
+export interface IWatermarkConfigWithType {
+    config: IWatermarkConfig;
+    type: IWatermarkTypeEnum;
+}

package/lib/types/components/sheets/watermark/util.d.ts

@@ -0,0 +1,7 @@
+import { IUser, Nullable } from '@univerjs/core';
+import { UniverRenderingContext } from '../../../context';
+import { IImageWatermarkConfig, ITextWatermarkConfig, IUserInfoWatermarkConfig, IWatermarkConfigWithType } from './type';
+export declare function renderWatermark(ctx: UniverRenderingContext, config: IWatermarkConfigWithType, image: Nullable<HTMLImageElement>, userInfo: Nullable<IUser>): void;
+export declare function renderUserInfoWatermark(ctx: UniverRenderingContext, config: IUserInfoWatermarkConfig, userInfo: Nullable<IUser>): void;
+export declare function renderTextWatermark(ctx: UniverRenderingContext, config: ITextWatermarkConfig): void;
+export declare function renderImageWatermark(ctx: UniverRenderingContext, config: IImageWatermarkConfig, image: Nullable<HTMLImageElement>): void;

package/lib/types/components/sheets/watermark/watermark-layer.d.ts

@@ -0,0 +1,12 @@
+import { IUser } from '@univerjs/core';
+import { UniverRenderingContext } from '../../../context';
+import { IWatermarkConfigWithType } from './type';
+import { Layer } from '../../../layer';
+export declare class WatermarkLayer extends Layer {
+    private _config;
+    private _image;
+    private _user;
+    render(ctx?: UniverRenderingContext, isMaxLayer?: boolean): this;
+    updateConfig(config?: IWatermarkConfigWithType, user?: IUser): void;
+    private _renderWatermark;
+}

package/lib/types/scene.d.ts

@@ -281,7 +281,7 @@ export declare class Scene extends Disposable {
     };
     dispose(): void;
     /**
-     * Get the object under the pointer, if scene.event is disabled, the object is null.
+     * Get the object under the pointer, if scene.event is disabled, return null.
      * @param {Vector2} coord
      * @return {Nullable<BaseObject | Scene>} object under the pointer
      */
@@ -315,4 +315,8 @@ export declare class Scene extends Disposable {
      */
     disableObjectsEvent(): void;
     enableObjectsEvent(): void;
+    _capturedObject: BaseObject | null;
+    get capturedObject(): BaseObject | null;
+    setCaptureObject(o: BaseObject): void;
+    releaseCapturedObject(): void;
 }

package/lib/types/scene.input-manager.d.ts

@@ -1,3 +1,4 @@
+import { BaseObject } from './base-object';
 import { IDragEvent, IKeyboardEvent, IMouseEvent, IPointerEvent, IWheelEvent } from './basics/i-events';
 import { ISceneInputControlOptions, Scene } from './scene';
 import { Disposable } from '@univerjs/core';
@@ -49,12 +50,20 @@ export declare class InputManager extends Disposable {
      */
     detachControl(): void;
     /**
-     * Just call this._scene.pick, nothing special.
+     * Get the object under the pointer, if scene.event is disabled, return null.
      * @param offsetX
      * @param offsetY
      */
     private _getObjectAtPos;
-    private _checkDirectSceneEventTrigger;
+    /**
+     *
+     * If currentObject is null, return true
+     * @param isTrigger
+     * @param currentObject
+     * @returns
+     */
+    private _shouldDispatchEventToScene;
+    private _isObjectInSceneViewer;
     /**
      * @hidden
      * @returns Boolean if delta for pointer exceeds drag movement threshold
@@ -62,4 +71,5 @@ export declare class InputManager extends Disposable {
     private _isPointerSwiping;
     private _prePointerDoubleOrTripleClick;
     private _resetDoubleClickParam;
+    get capturedObject(): BaseObject | null;
 }

package/lib/types/shape/base-scroll-bar.d.ts

@@ -1,8 +1,8 @@
+import { Nullable, Disposable } from '@univerjs/core';
 import { Vector2 } from '../basics/vector2';
 import { UniverRenderingContext } from '../context';
 import { Scene } from '../scene';
 import { Rect } from './rect';
-import { Disposable, Nullable } from '@univerjs/core';
 export interface IScrollBarProps {
     thumbMargin?: number;
     thumbLengthRatio?: number;
@@ -25,14 +25,14 @@ export interface IScrollBarProps {
 export declare abstract class BaseScrollBar extends Disposable {
     enableHorizontal: boolean;
     enableVertical: boolean;
-    horizontalThumbWidth: number;
+    horizontalThumbSize: number;
     horizontalMinusMiniThumb: number;
     horizontalBarWidth: number;
-    verticalThumbHeight: number;
-    verticalBarHeight: number;
-    verticalMinusMiniThumb: number;
     horizonScrollTrack: Nullable<Rect>;
     horizonThumbRect: Nullable<Rect>;
+    verticalThumbSize: number;
+    verticalBarHeight: number;
+    verticalMinusMiniThumb: number;
     verticalScrollTrack: Nullable<Rect>;
     verticalThumbRect: Nullable<Rect>;
     placeholderBarRect: Nullable<Rect>;

package/lib/types/shape/scroll-bar.d.ts

@@ -15,10 +15,15 @@ export declare class ScrollBar extends BaseScrollBar {
     private _verticalPointerMoveSub;
     private _verticalPointerUpSub;
     /**
-     * The thickness of a scrolling bar.
+     * The thickness of a scrolling track
+     * ThumbSize = barSize - thumbMargin * 2
      */
     barSize: number;
     barBorder: number;
+    /**
+     * The margin between thumb and bar.
+     * ThumbSize = barSize - thumbMargin * 2
+     */
     thumbMargin: number;
     thumbLengthRatio: number;
     /**
@@ -38,6 +43,7 @@ export declare class ScrollBar extends BaseScrollBar {
      */
     minThumbSizeV: number;
     private _eventSub;
+    get scrollHandleThickness(): number;
     constructor(view: Viewport, props?: IScrollBarProps);
     static attachTo(view: Viewport, props?: IScrollBarProps): ScrollBar;
     dispose(): void;