@kengic/vue 0.26.6-beta.107 → 0.26.6-beta.109

package/dist/src/component/KgAppSelect/index.hooks.d.ts

@@ -1,4 +1,4 @@
-import { IRemoveEventListenerHandler, KG_APP, Menu } from '../../const';
+import { IRemoveEventListener, KG_APP, Menu } from '../../const';
 import { IKgAppSelectGotoAppEventListener, IKgAppSelectGotoPathEventListener, IKgAppSelectStore } from './index.store';
 export declare type IUseKgAppSelect = {
     /** 状态数据. */
@@ -30,12 +30,12 @@ export declare type IUseKgAppSelect = {
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onGotoApp(listener: IKgAppSelectGotoAppEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onGotoApp(listener: IKgAppSelectGotoAppEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 进入某个地址.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onGotoPath(listener: IKgAppSelectGotoPathEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onGotoPath(listener: IKgAppSelectGotoPathEventListener, isOnce?: boolean): IRemoveEventListener;
 };
 export declare function useKgAppSelect(): IUseKgAppSelect;

package/dist/src/component/KgAppSelect/index.store.d.ts

@@ -37,9 +37,9 @@ export interface IUseKgAppSelectStoreActions {
     /**
      * 触发事件.
      * @param event 事件名称.
-     * @param param 参数.
+     * @param parameter 事件参数.
      */
-    emit<T = IKgAppSelectEventListenerParameter>(event: IKgAppSelectEvent, param?: T | null): Promise<boolean>;
+    emit<T = IKgAppSelectEventListenerParameter>(event: IKgAppSelectEvent, parameter?: T | null): Promise<boolean>;
     /**
      * 进入某个模块.
      * @param app 要进入的模块.

package/dist/src/component/KgButton/index.hooks.d.ts

@@ -1,5 +1,5 @@
 import { ComputedRef } from 'vue';
-import { IRemoveEventListenerHandler, KG__VAR_BUTTON__TYPE } from '../../const';
+import { IRemoveEventListener, KG__VAR_BUTTON__TYPE } from '../../const';
 import { IKgButtonClickEventListener, IKgButtonImportOkEventListener, IKgButtonStore, IKgButtonSubmitCancelEventListener, IKgButtonSubmitSaveEventListener } from './index.store';
 export interface IUseKgButton {
     /**
@@ -85,28 +85,28 @@ export interface IUseKgButton {
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onClick(listener: IKgButtonClickEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onClick(listener: IKgButtonClickEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 导入成功, 导入接口调用成功.
      *
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onImportOk(listener: IKgButtonImportOkEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onImportOk(listener: IKgButtonImportOkEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 表格内编辑时, 点击取消按钮.
      *
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onSubmitCancel(listener: IKgButtonSubmitCancelEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onSubmitCancel(listener: IKgButtonSubmitCancelEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 表格内编辑时, 点击保存按钮.
      *
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onSubmitSave(listener: IKgButtonSubmitSaveEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onSubmitSave(listener: IKgButtonSubmitSaveEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * <p>「查询按钮」.</p>
      */

package/dist/src/component/KgButton/index.store.d.ts

@@ -88,9 +88,9 @@ export interface IUseKgButtonStoreActions {
      * 触发事件.
      * @param formID 界面标识.
      * @param event 事件名称.
-     * @param param 数据.
+     * @param parameter 事件参数.
      */
-    emit<T = IKgButtonEventListenerParameter>(formID: string, event: IKgButtonEvent, param: T): Promise<boolean>;
+    emit<T = IKgButtonEventListenerParameter>(formID: string, event: IKgButtonEvent, parameter: T): Promise<boolean>;
     /**
      * 退订事件监听.
      * @param formID 界面标识.

package/dist/src/component/KgCanvas/KgCanvas.ContextMenu.d.ts

@@ -26,7 +26,6 @@ export declare type IKgCanvasContextMenu = {
     name?: string;
 };
 export declare const getProps: () => {
-    eid: PropType<string>;
     kgElement: PropType<Q.Element<any>>;
     kgElementUi: PropType<Q.ElementUI>;
     /**
@@ -51,7 +50,6 @@ export declare const getProps: () => {
 };
 export declare type KgCanvasContextMenuProps = Partial<ExtractPropTypes<ReturnType<typeof getProps>>>;
 declare const _default: import("vue").DefineComponent<{
-    eid: PropType<string>;
     kgElement: PropType<Q.Element<any>>;
     kgElementUi: PropType<Q.ElementUI>;
     /**
@@ -74,7 +72,6 @@ declare const _default: import("vue").DefineComponent<{
     kgUi: PropType<Q.BaseUI>;
     'onUpdate:kgIsVisible': PropType<(value: boolean) => void>;
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, "update:kgIsVisible"[], "update:kgIsVisible", import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
-    eid: PropType<string>;
     kgElement: PropType<Q.Element<any>>;
     kgElementUi: PropType<Q.ElementUI>;
     /**

package/dist/src/component/KgCanvas/KgCanvas.d.ts

@@ -1,6 +1,11 @@
 import { ExtractPropTypes, PropType } from 'vue';
 import './KgCanvas.css';
 export declare const getProps: () => {
+    /** 该组件实例的唯一标识. */
+    id: {
+        type: PropType<string>;
+        required: boolean;
+    };
     /**
      * 组件 KgCanvasToolbarFullscreen 的参数.
      */
@@ -51,6 +56,11 @@ export declare const getProps: () => {
 };
 export declare type KgCanvasProps = Partial<ExtractPropTypes<ReturnType<typeof getProps>>>;
 declare const _default: import("vue").DefineComponent<{
+    /** 该组件实例的唯一标识. */
+    id: {
+        type: PropType<string>;
+        required: boolean;
+    };
     /**
      * 组件 KgCanvasToolbarFullscreen 的参数.
      */
@@ -99,6 +109,11 @@ declare const _default: import("vue").DefineComponent<{
         default: boolean;
     };
 }, () => JSX.Element, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<ExtractPropTypes<{
+    /** 该组件实例的唯一标识. */
+    id: {
+        type: PropType<string>;
+        required: boolean;
+    };
     /**
      * 组件 KgCanvasToolbarFullscreen 的参数.
      */

package/dist/src/component/KgCanvas/KgCanvas.service.d.ts

@@ -31,12 +31,9 @@ export declare type IKgCanvasElementProperties = {
 export declare type IUseGlobalContextMenus = {
     globalContextMenus: Array<IKgCanvasContextMenu>;
 };
-export declare function _useGlobalContextMenus(param: {
-    eid: string;
-}): IUseGlobalContextMenus;
+export declare function _useGlobalContextMenus(param: {}): IUseGlobalContextMenus;
 export declare type IUseResizeObserver = {};
 export declare function _useResizeObserver(param: {
-    eid: string;
     graph: () => Q.Graph | null;
     kgCanvasContextMenuProps: Ref<KgCanvasContextMenuProps>;
     kgCanvasRef: Ref<HTMLDivElement | null>;

package/dist/src/component/KgCanvas/index.event.d.ts

@@ -0,0 +1,225 @@
+import { Q } from '@thymine/xunee';
+import { Ref } from 'vue';
+import { IKgEventListener } from '../../const';
+import { IKgCanvasContextMenu } from './KgCanvas.ContextMenu';
+/**
+ * 事件类型.
+ *   'onInit':             图形组件初始完成
+ *   'onReload':           重新加载
+ *   'onResize':           尺寸变化
+ *   'onMouseMove':        鼠标移动
+ *   'onMouseEnter':       鼠标进入
+ *   'onMouseLeave':       鼠标离开
+ *   'onClick':            单击鼠标左键
+ *   'onRightClick':       单击鼠标右键
+ *   'onContextMenuOpen':  右键菜单打开
+ *   'onContextMenuClose': 右键菜单关闭
+ */
+export declare type IKgCanvasEvent = 'onInit' | 'onReload' | 'onResize' | 'onMouseMove' | 'onMouseEnter' | 'onMouseLeave' | 'onClick' | 'onRightClick' | 'onContextMenuOpen' | 'onContextMenuClose';
+export declare type IKgCanvasOnInitEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+};
+export declare type IKgCanvasOnInitEventListener = ((param: IKgCanvasOnInitEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnReloadEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+};
+export declare type IKgCanvasOnReloadEventListener = ((param: IKgCanvasOnReloadEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnResizeEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+    /**
+     * 当前高度.
+     */
+    height: number;
+    /**
+     * 当前宽度.
+     */
+    width: number;
+};
+export declare type IKgCanvasOnResizeEventListener = ((param: IKgCanvasOnResizeEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnRightClickEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * <p>右键菜单列表.</p>
+     * <p>用户可以直接修改该参数的值, 从而修改此次单击右键事件弹出的右键菜单.</p>
+     */
+    contextMenus: Ref<Array<IKgCanvasContextMenu>>;
+    /**
+     * 图元.
+     */
+    element?: Q.Element;
+    /**
+     * 图元组件.
+     */
+    elementUI?: Q.ElementUI;
+    /**
+     * 鼠标事件.
+     */
+    event: MouseEvent;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+    /**
+     * 图元组件.
+     */
+    ui?: Q.BaseUI;
+};
+export declare type IKgCanvasOnRightClickEventListener = ((param: IKgCanvasOnRightClickEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnMouseMoveEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图元.
+     */
+    element?: Q.Element;
+    /**
+     * 图元组件.
+     */
+    elementUI?: Q.ElementUI;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+    /**
+     * 图元组件.
+     */
+    ui?: Q.BaseUI;
+};
+export declare type IKgCanvasOnMouseMoveEventListener = ((param: IKgCanvasOnMouseMoveEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnMouseLeaveEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图元.
+     */
+    element?: Q.Element;
+    /**
+     * 图元组件.
+     */
+    elementUI?: Q.ElementUI;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+    /**
+     * 图元组件.
+     */
+    ui?: Q.BaseUI;
+};
+export declare type IKgCanvasOnMouseLeaveEventListener = ((param: IKgCanvasOnMouseLeaveEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnMouseEnterEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图元.
+     */
+    element?: Q.Element;
+    /**
+     * 图元组件.
+     */
+    elementUI?: Q.ElementUI;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+    /**
+     * 图元组件.
+     */
+    ui?: Q.BaseUI;
+};
+export declare type IKgCanvasOnMouseEnterEventListener = ((param: IKgCanvasOnMouseEnterEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnClickEventListenerParameter = {
+    /**
+     * Q.
+     */
+    Q: typeof Q;
+    /**
+     * 图元.
+     */
+    element?: Q.Element;
+    /**
+     * 图元组件.
+     */
+    elementUI?: Q.ElementUI;
+    /**
+     * 图形组件对象.
+     */
+    graph: Q.Graph;
+    /**
+     * 图元组件.
+     */
+    ui?: Q.BaseUI;
+};
+export declare type IKgCanvasOnClickEventListener = ((param: IKgCanvasOnClickEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnContextMenuOpenEventListenerParameter = {};
+export declare type IKgCanvasOnContextMenuOpenEventListener = ((param: IKgCanvasOnContextMenuOpenEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasOnContextMenuCloseEventListenerParameter = {};
+export declare type IKgCanvasOnContextMenuCloseEventListener = ((param: IKgCanvasOnContextMenuCloseEventListenerParameter) => Promise<boolean>) & IKgEventListener;
+export declare type IKgCanvasEventListenerParameter = IKgCanvasOnInitEventListenerParameter | IKgCanvasOnReloadEventListenerParameter | IKgCanvasOnResizeEventListenerParameter | IKgCanvasOnRightClickEventListenerParameter | IKgCanvasOnMouseMoveEventListenerParameter | IKgCanvasOnMouseEnterEventListenerParameter | IKgCanvasOnMouseLeaveEventListenerParameter | IKgCanvasOnClickEventListenerParameter | IKgCanvasOnContextMenuOpenEventListenerParameter | IKgCanvasOnContextMenuCloseEventListenerParameter;
+export declare type IKgCanvasEventListener = IKgCanvasOnInitEventListener | IKgCanvasOnReloadEventListener | IKgCanvasOnResizeEventListener | IKgCanvasOnRightClickEventListener | IKgCanvasOnMouseMoveEventListener | IKgCanvasOnMouseEnterEventListener | IKgCanvasOnMouseLeaveEventListener | IKgCanvasOnClickEventListener | IKgCanvasOnContextMenuOpenEventListener | IKgCanvasOnContextMenuCloseEventListener;
+/**
+ * 添加事件监听.
+ *
+ * @param param.event 事件名称.
+ * @param param.id 唯一标识.
+ * @param param.listener 事件监听函数.
+ */
+export declare function addEventListener<T extends IKgCanvasEventListener>(param: {
+    event: IKgCanvasEvent;
+    id?: string | undefined;
+    listener: T;
+}): void;
+/**
+ * 移除事件监听.
+ *
+ * @param param.event 事件名称.
+ * @param param.id 唯一标识.
+ * @param param.listener 事件监听函数.
+ */
+export declare function removeEventListener(param: {
+    event: IKgCanvasEvent;
+    id?: string | undefined;
+    listener?: any;
+}): void;
+/**
+ * 触发事件.
+ *
+ * @param param.event 事件名称.
+ * @param param.id 唯一标识.
+ * @param param.parameter 事件参数.
+ */
+export declare function emit<T = IKgCanvasEventListenerParameter>(param: {
+    event: IKgCanvasEvent;
+    id?: string | undefined;
+    parameter: T;
+}): Promise<boolean>;

package/dist/src/component/KgCanvas/index.hooks.d.ts

@@ -1,67 +1,72 @@
-import { IRemoveEventListenerHandler } from '../../const';
-import { IKgCanvasOnClickEventListener, IKgCanvasOnContextMenuCloseEventListener, IKgCanvasOnContextMenuOpenEventListener, IKgCanvasOnInitEventListener, IKgCanvasOnMouseEnterEventListener, IKgCanvasOnMouseLeaveEventListener, IKgCanvasOnMouseMoveEventListener, IKgCanvasOnReloadEventListener, IKgCanvasOnResizeEventListener, IKgCanvasOnRightClickEventListener, IKgCanvasStore } from './index.store';
+import { IRemoveEventListener } from '../../const';
+import { IKgCanvasOnClickEventListener, IKgCanvasOnContextMenuCloseEventListener, IKgCanvasOnContextMenuOpenEventListener, IKgCanvasOnInitEventListener, IKgCanvasOnMouseEnterEventListener, IKgCanvasOnMouseLeaveEventListener, IKgCanvasOnMouseMoveEventListener, IKgCanvasOnReloadEventListener, IKgCanvasOnResizeEventListener, IKgCanvasOnRightClickEventListener } from './index.event';
+import { IKgCanvasStore } from './index.store';
 export declare type IUseKgCanvas = {
     /**
      * 监听事件: 单击鼠标左键.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onClick(listener: IKgCanvasOnClickEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onClick(listener: IKgCanvasOnClickEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 右键菜单关闭.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onContextMenuClose(listener: IKgCanvasOnContextMenuCloseEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onContextMenuClose(listener: IKgCanvasOnContextMenuCloseEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 右键菜单打开.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onContextMenuOpen(listener: IKgCanvasOnContextMenuOpenEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onContextMenuOpen(listener: IKgCanvasOnContextMenuOpenEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 图形组件初始完成.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onInit(listener: IKgCanvasOnInitEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onInit(listener: IKgCanvasOnInitEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 鼠标进入.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onMouseEnter(listener: IKgCanvasOnMouseEnterEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onMouseEnter(listener: IKgCanvasOnMouseEnterEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 鼠标离开.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onMouseLeave(listener: IKgCanvasOnMouseLeaveEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onMouseLeave(listener: IKgCanvasOnMouseLeaveEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 鼠标移动.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onMouseMove(listener: IKgCanvasOnMouseMoveEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onMouseMove(listener: IKgCanvasOnMouseMoveEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 重新加载.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onReload(listener: IKgCanvasOnReloadEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onReload(listener: IKgCanvasOnReloadEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 尺寸变化.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onResize(listener: IKgCanvasOnResizeEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onResize(listener: IKgCanvasOnResizeEventListener, isOnce?: boolean): IRemoveEventListener;
     /**
      * 监听事件: 单击鼠标右键.
      * @param listener 事件监听函数.
      * @param isOnce 是否只会触发一次. 默认为 undefined.
      */
-    onRightClick(listener: IKgCanvasOnRightClickEventListener, isOnce?: boolean): IRemoveEventListenerHandler;
+    onRightClick(listener: IKgCanvasOnRightClickEventListener, isOnce?: boolean): IRemoveEventListener;
     /** 状态数据. */
     store: IKgCanvasStore;
 };
-export declare function useKgCanvas(): IUseKgCanvas;
+/**
+ *
+ * @param id 唯一标识.
+ */
+export declare function useKgCanvas(id: string): IUseKgCanvas;