@univerjs/sheets-graphics 0.5.1-nightly.202412061606

package/README.md

@@ -0,0 +1,27 @@
+# @univerjs/sheets-graphics
+
+## Package Overview
+
+| Package Name | UMD Namespace | Version | License | Downloads | Contains CSS | Contains i18n locales |
+| --- | --- | --- | --- | --- | :---: | :---: |
+| `@univerjs/sheets-graphics` | `UniverSheetGraphicsPlugin` | [![][npm-version-shield]][npm-version-link] | ![][npm-license-shield] | ![][npm-downloads-shield] | ❌ | ❌ |
+
+## Introduction
+
+`@univerjs/sheets-graphics` is a basic in-cell graphics drawing plugin for Univer Sheet.
+
+## Installation
+
+```shell
+# Using npm
+npm install @univerjs/sheets-graphics
+
+# Using pnpm
+pnpm add @univerjs/sheets-graphics
+```
+
+<!-- Links -->
+[npm-version-shield]: https://img.shields.io/npm/v/@univerjs/sheets-graphics?style=flat-square
+[npm-version-link]: https://npmjs.com/package/@univerjs/sheets-graphics
+[npm-license-shield]: https://img.shields.io/npm/l/@univerjs/sheets-graphics?style=flat-square
+[npm-downloads-shield]: https://img.shields.io/npm/dm/@univerjs/sheets-graphics?style=flat-square

package/lib/cjs/index.js

@@ -0,0 +1 @@
+"use strict";var v=Object.defineProperty;var P=(s,r,e)=>r in s?v(s,r,{enumerable:!0,configurable:!0,writable:!0,value:e}):s[r]=e;var a=(s,r,e)=>P(s,typeof r!="symbol"?r+"":r,e);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i=require("@univerjs/core"),d=require("@univerjs/engine-render"),N="graphics.config",G={},l="SheetGraphicsExtension",x=35;class M extends d.SheetExtension{constructor(){super(...arguments);a(this,"uKey",l);a(this,"Z_INDEX",x);a(this,"_graphicsRenderMap",new Map)}registerRenderer(e,t){this._graphicsRenderMap.set(e,t)}draw(e,t,n,c,{viewRanges:o}){const u=Array.from(this._graphicsRenderMap.keys());o.forEach(E=>{i.Range.foreach(E,(I,R)=>{const _=n.getCellByIndexWithNoHeader(I,R);_&&u.forEach(S=>{const h=this._graphicsRenderMap.get(S);h==null||h(e,n,_)})})})}dispose(){this._graphicsRenderMap.clear()}}class f extends i.Disposable{constructor(e){super();a(this,"_graphicsExtensionInstance",null);this._context=e,this._initRender()}_initRender(){const e=this._context.mainComponent;e&&!e.getExtensionByKey(l)&&(this._graphicsExtensionInstance=new M,e.register(this._graphicsExtensionInstance))}registerRenderer(e,t){var n;(n=this._graphicsExtensionInstance)==null||n.registerRenderer(e,t)}}var U=Object.defineProperty,y=Object.getOwnPropertyDescriptor,C=(s,r,e,t)=>{for(var n=t>1?void 0:t?y(r,e):r,c=s.length-1,o;c>=0;c--)(o=s[c])&&(n=(t?o(r,e,n):o(n))||n);return t&&n&&U(r,e,n),n},g=(s,r)=>(e,t)=>r(e,t,s);const O="UNIVER_SHEET_DRAWING_PLUGIN";var p;exports.UniverSheetGraphicsPlugin=(p=class extends i.Plugin{constructor(r=G,e,t,n){super(),this._config=r,this._injector=e,this._configService=t,this._renderManagerService=n;const{...c}=this._config;this._configService.setConfig(N,c)}onRendered(){[[f]].forEach(r=>{this._renderManagerService.registerRenderModule(i.UniverInstanceType.UNIVER_SHEET,r)})}},a(p,"pluginName",O),p);exports.UniverSheetGraphicsPlugin=C([g(1,i.Inject(i.Injector)),g(2,i.IConfigService),g(3,d.IRenderManagerService)],exports.UniverSheetGraphicsPlugin);exports.SheetGraphicsRenderController=f;

package/lib/es/index.js

@@ -0,0 +1,77 @@
+var u = Object.defineProperty;
+var v = (n, r, e) => r in n ? u(n, r, { enumerable: !0, configurable: !0, writable: !0, value: e }) : n[r] = e;
+var i = (n, r, e) => v(n, typeof r != "symbol" ? r + "" : r, e);
+import { Range as N, Disposable as S, Inject as x, Injector as P, Plugin as M, UniverInstanceType as G, IConfigService as m } from "@univerjs/core";
+import { SheetExtension as C, IRenderManagerService as U } from "@univerjs/engine-render";
+const y = "graphics.config", D = {}, d = "SheetGraphicsExtension", O = 35;
+class j extends C {
+  constructor() {
+    super(...arguments);
+    i(this, "uKey", d);
+    i(this, "Z_INDEX", O);
+    i(this, "_graphicsRenderMap", /* @__PURE__ */ new Map());
+  }
+  registerRenderer(e, t) {
+    this._graphicsRenderMap.set(e, t);
+  }
+  draw(e, t, s, a, { viewRanges: c }) {
+    const f = Array.from(this._graphicsRenderMap.keys());
+    c.forEach((E) => {
+      N.foreach(E, (l, I) => {
+        const p = s.getCellByIndexWithNoHeader(l, I);
+        p && f.forEach((R) => {
+          const o = this._graphicsRenderMap.get(R);
+          o == null || o(e, s, p);
+        });
+      });
+    });
+  }
+  dispose() {
+    this._graphicsRenderMap.clear();
+  }
+}
+class w extends S {
+  constructor(e) {
+    super();
+    i(this, "_graphicsExtensionInstance", null);
+    this._context = e, this._initRender();
+  }
+  _initRender() {
+    const e = this._context.mainComponent;
+    e && !e.getExtensionByKey(d) && (this._graphicsExtensionInstance = new j(), e.register(this._graphicsExtensionInstance));
+  }
+  registerRenderer(e, t) {
+    var s;
+    (s = this._graphicsExtensionInstance) == null || s.registerRenderer(e, t);
+  }
+}
+var T = Object.defineProperty, A = Object.getOwnPropertyDescriptor, H = (n, r, e, t) => {
+  for (var s = t > 1 ? void 0 : t ? A(r, e) : r, a = n.length - 1, c; a >= 0; a--)
+    (c = n[a]) && (s = (t ? c(r, e, s) : c(s)) || s);
+  return t && s && T(r, e, s), s;
+}, h = (n, r) => (e, t) => r(e, t, n);
+const K = "UNIVER_SHEET_DRAWING_PLUGIN";
+var _;
+let g = (_ = class extends M {
+  constructor(n = D, r, e, t) {
+    super(), this._config = n, this._injector = r, this._configService = e, this._renderManagerService = t;
+    const { ...s } = this._config;
+    this._configService.setConfig(y, s);
+  }
+  onRendered() {
+    [
+      [w]
+    ].forEach((n) => {
+      this._renderManagerService.registerRenderModule(G.UNIVER_SHEET, n);
+    });
+  }
+}, i(_, "pluginName", K), _);
+g = H([
+  h(1, x(P)),
+  h(2, m),
+  h(3, U)
+], g);
+export {
+  w as SheetGraphicsRenderController,
+  g as UniverSheetGraphicsPlugin
+};

package/lib/types/common/const.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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 const UNIQUE_KEY = "SheetGraphicsExtension";
+export declare const GRAPHICS_EXTENSION_INDEX = 35;

package/lib/types/controllers/config.schema.d.ts

@@ -0,0 +1,7 @@
+import { DependencyOverride } from '@univerjs/core';
+export declare const PLUGIN_CONFIG_KEY = "graphics.config";
+export declare const configSymbol: unique symbol;
+export interface IUniverSheetGraphicsConfig {
+    override?: DependencyOverride;
+}
+export declare const defaultPluginConfig: IUniverSheetGraphicsConfig;

package/lib/types/controllers/graphics-render.controller.d.ts

@@ -0,0 +1,9 @@
+import { ISelectionCellWithMergeInfo, Disposable } from '@univerjs/core';
+import { IRenderContext, IRenderModule, SpreadsheetSkeleton, UniverRenderingContext } from '@univerjs/engine-render';
+export declare class SheetGraphicsRenderController extends Disposable implements IRenderModule {
+    private readonly _context;
+    private _graphicsExtensionInstance;
+    constructor(_context: IRenderContext);
+    private _initRender;
+    registerRenderer(key: string, renderer: (ctx: UniverRenderingContext, skeleton: SpreadsheetSkeleton, coordInfo: ISelectionCellWithMergeInfo) => void): void;
+}

package/lib/types/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright 2023-present DreamNum Inc.
+ *
+ * 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 { UniverSheetGraphicsPlugin } from './plugin';
+export { SheetGraphicsRenderController } from './controllers/graphics-render.controller';

package/lib/types/plugin.d.ts

@@ -0,0 +1,12 @@
+import { IUniverSheetGraphicsConfig } from './controllers/config.schema';
+import { IConfigService, Injector, Plugin } from '@univerjs/core';
+import { IRenderManagerService } from '@univerjs/engine-render';
+export declare class UniverSheetGraphicsPlugin extends Plugin {
+    private readonly _config;
+    protected _injector: Injector;
+    private readonly _configService;
+    private readonly _renderManagerService;
+    static pluginName: string;
+    constructor(_config: Partial<IUniverSheetGraphicsConfig> | undefined, _injector: Injector, _configService: IConfigService, _renderManagerService: IRenderManagerService);
+    onRendered(): void;
+}

package/lib/types/views/extensions/graphics.extension.d.ts

@@ -0,0 +1,12 @@
+import { IRange, IScale, ISelectionCellWithMergeInfo } from '@univerjs/core';
+import { IDrawInfo, SpreadsheetSkeleton, UniverRenderingContext, SheetExtension } from '@univerjs/engine-render';
+type IGraphicsRenderer = (ctx: UniverRenderingContext, skeleton: SpreadsheetSkeleton, coordInfo: ISelectionCellWithMergeInfo) => void;
+export declare class Graphics extends SheetExtension {
+    uKey: string;
+    protected Z_INDEX: number;
+    private _graphicsRenderMap;
+    registerRenderer(key: string, renderer: IGraphicsRenderer): void;
+    draw(ctx: UniverRenderingContext, _parentScale: IScale, skeleton: SpreadsheetSkeleton, diffBounds: IRange[], { viewRanges }: IDrawInfo): void;
+    dispose(): void;
+}
+export {};

package/lib/umd/index.js

@@ -0,0 +1 @@
+(function(r,e){typeof exports=="object"&&typeof module<"u"?e(exports,require("@univerjs/core"),require("@univerjs/engine-render")):typeof define=="function"&&define.amd?define(["exports","@univerjs/core","@univerjs/engine-render"],e):(r=typeof globalThis<"u"?globalThis:r||self,e(r.UniverSheetsGraphics={},r.UniverCore,r.UniverEngineRender))})(this,function(r,e,c){"use strict";var M=Object.defineProperty;var j=(r,e,c)=>e in r?M(r,e,{enumerable:!0,configurable:!0,writable:!0,value:c}):r[e]=c;var h=(r,e,c)=>j(r,typeof e!="symbol"?e+"":e,c);var d;const E="graphics.config",v={},f="SheetGraphicsExtension";class I extends c.SheetExtension{constructor(){super(...arguments);h(this,"uKey",f);h(this,"Z_INDEX",35);h(this,"_graphicsRenderMap",new Map)}registerRenderer(n,s){this._graphicsRenderMap.set(n,s)}draw(n,s,i,o,{viewRanges:p}){const G=Array.from(this._graphicsRenderMap.keys());p.forEach(U=>{e.Range.foreach(U,(x,y)=>{const l=i.getCellByIndexWithNoHeader(x,y);l&&G.forEach(C=>{const g=this._graphicsRenderMap.get(C);g==null||g(n,i,l)})})})}dispose(){this._graphicsRenderMap.clear()}}class u extends e.Disposable{constructor(n){super();h(this,"_graphicsExtensionInstance",null);this._context=n,this._initRender()}_initRender(){const n=this._context.mainComponent;n&&!n.getExtensionByKey(f)&&(this._graphicsExtensionInstance=new I,n.register(this._graphicsExtensionInstance))}registerRenderer(n,s){var i;(i=this._graphicsExtensionInstance)==null||i.registerRenderer(n,s)}}var S=Object.defineProperty,R=Object.getOwnPropertyDescriptor,N=(a,t,n,s)=>{for(var i=s>1?void 0:s?R(t,n):t,o=a.length-1,p;o>=0;o--)(p=a[o])&&(i=(s?p(t,n,i):p(i))||i);return s&&i&&S(t,n,i),i},_=(a,t)=>(n,s)=>t(n,s,a);const P="UNIVER_SHEET_DRAWING_PLUGIN";r.UniverSheetGraphicsPlugin=(d=class extends e.Plugin{constructor(t=v,n,s,i){super(),this._config=t,this._injector=n,this._configService=s,this._renderManagerService=i;const{...o}=this._config;this._configService.setConfig(E,o)}onRendered(){[[u]].forEach(t=>{this._renderManagerService.registerRenderModule(e.UniverInstanceType.UNIVER_SHEET,t)})}},h(d,"pluginName",P),d),r.UniverSheetGraphicsPlugin=N([_(1,e.Inject(e.Injector)),_(2,e.IConfigService),_(3,c.IRenderManagerService)],r.UniverSheetGraphicsPlugin),r.SheetGraphicsRenderController=u,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})});

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@univerjs/sheets-graphics",
+  "version": "0.5.1-nightly.202412061606",
+  "private": false,
+  "description": "Drawing graphics for Univer Sheets",
+  "author": "DreamNum <developer@univer.ai>",
+  "license": "Apache-2.0",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/univer"
+  },
+  "homepage": "https://univer.ai",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dream-num/univer"
+  },
+  "bugs": {
+    "url": "https://github.com/dream-num/univer/issues"
+  },
+  "keywords": [],
+  "exports": {
+    ".": {
+      "import": "./lib/es/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./*": {
+      "import": "./lib/es/*",
+      "require": "./lib/cjs/*",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./lib/*": "./lib/*"
+  },
+  "main": "./lib/es/index.js",
+  "types": "./lib/types/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "directories": {
+    "lib": "lib"
+  },
+  "files": [
+    "lib"
+  ],
+  "peerDependencies": {
+    "rxjs": ">=7.0.0"
+  },
+  "dependencies": {
+    "@univerjs/core": "0.5.1-nightly.202412061606",
+    "@univerjs/engine-render": "0.5.1-nightly.202412061606"
+  },
+  "devDependencies": {
+    "rxjs": "^7.8.1",
+    "typescript": "^5.7.2",
+    "vite": "^6.0.3",
+    "vitest": "^2.1.8",
+    "@univerjs-infra/shared": "0.5.1"
+  },
+  "space": {
+    ".": {
+      "import": "./lib/es/index.js",
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./*": {
+      "import": "./lib/es/*",
+      "require": "./lib/cjs/*",
+      "types": "./lib/types/index.d.ts"
+    },
+    "./lib/*": "./lib/*"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "lint:types": "tsc --noEmit",
+    "build": "univer-cli build"
+  },
+  "module": "./lib/es/index.js"
+}