Interface IUiModule

interface IUiModule {
    addControl: ((control, position?) => App);
    getConfigPane: ((opts?) => Promise<{
        appendChild: ((config?, params?) => any);
        configPane: any;
        element: HTMLElement;
        isInit: boolean;
        isVisible: (() => boolean);
        renderUiConfig: ((uiConfig) => void);
        renderUiObject: ((uiConfig, parent?) => any);
        reset: (() => void);
        rootPane: any;
        setVisible: ((b) => void);
    }>);
    hasControl: ((control) => void);
    logInfo: ((text, type?, time?) => void);
    removeControl: ((control) => App);
    setCursor: ((cur) => void);
}

Implemented by

Properties

addControl getConfigPane hasControl logInfo removeControl setCursor

Properties

addControl

addControl: ((control, position?) => App)

增加控件 (会调用 control.onAdd(this) ).

Type declaration

    • (control, position?): App

    • 增加控件 (会调用 control.onAdd(this) ).

      Parameters

      • control: IControl

        需要增加的控件.

      • Optional position: ControlPosition

        位置. 'top-left', 'top-right', 'bottom-left', and 'bottom-right'. Defaults to 'top-right'`

      Returns App

Param: control

需要增加的控件.

Param: position

位置. 'top-left', 'top-right', 'bottom-left', and 'bottom-right'. Defaults to 'top-right'`

getConfigPane

getConfigPane: ((opts?) => Promise<{
    appendChild: ((config?, params?) => any);
    configPane: any;
    element: HTMLElement;
    isInit: boolean;
    isVisible: (() => boolean);
    renderUiConfig: ((uiConfig) => void);
    renderUiObject: ((uiConfig, parent?) => any);
    reset: (() => void);
    rootPane: any;
    setVisible: ((b) => void);
}>)

获取配置面板

Type declaration

    • (opts?): Promise<{
          appendChild: ((config?, params?) => any);
          configPane: any;
          element: HTMLElement;
          isInit: boolean;
          isVisible: (() => boolean);
          renderUiConfig: ((uiConfig) => void);
          renderUiObject: ((uiConfig, parent?) => any);
          reset: (() => void);
          rootPane: any;
          setVisible: ((b) => void);
      }>

    • 获取配置面板

      Parameters

      • Optional opts: {
            isReset?: boolean;
            style?: Partial<CSSStyleDeclaration>;
            title?: string;
        }
        • Optional isReset?: boolean

          是否清空，默认是

        • Optional style?: Partial<CSSStyleDeclaration>

          样式

        • Optional title?: string

          标题

      Returns Promise<{
          appendChild: ((config?, params?) => any);
          configPane: any;
          element: HTMLElement;
          isInit: boolean;
          isVisible: (() => boolean);
          renderUiConfig: ((uiConfig) => void);
          renderUiObject: ((uiConfig, parent?) => any);
          reset: (() => void);
          rootPane: any;
          setVisible: ((b) => void);
      }>

hasControl

hasControl: ((control) => void)

是否有控件.

Type declaration

    • (control): void

    • 是否有控件.

      Parameters

      Returns void

Param: control

要查询的控件.

logInfo

logInfo: ((text, type?, time?) => void)

信息弹窗提示 text（必填）：需要输出的文本 type（可选）：输出类型 默认是 "log" time（可选）：停留时间 默认是 2500

Type declaration

    • (text, type?, time?): void

    • 信息弹窗提示 text（必填）：需要输出的文本 type（可选）：输出类型 默认是 "log" time（可选）：停留时间 默认是 2500

      Parameters

      • text: string
      • Optional type: number | logInfoType
      • Optional time: number

      Returns void

removeControl

removeControl: ((control) => App)

移除控件.

Type declaration

    • (control): App

    • 移除控件.

      Parameters

      Returns App

Param: control

要移除的控件.

setCursor

setCursor: ((cur) => void)

设置光标

Type declaration

    • (cur): void

    • 设置光标

      Parameters

      • cur: string

        光标名称

      Returns void

Param: cur

光标名称

Settings

Member Visibility

Theme

On This Page