Class MainView

主视图类 - 使用 Lit 官方推荐的静态属性写法

Hierarchy (View Summary)

LitElement
- MainView

Index

Constructors

constructor

Accessors

observedAttributes updateComplete

Constructors

constructor

new MainView(config?: MainViewConfig): MainView
构造函数
Parameters
- Optionalconfig: MainViewConfig
  配置对象
  
  主视图配置接口
  - Optionalappname?: string
  - Optionalversion?: string
  - OptionalwasmServiceUrl?: string
  - OptionalserviceUrl?: string
  - Optionalworkspace?: string
  - OptionalaccessToken?: string
  - OptionalaccessKey?: string
  - Optionalfonts?: { path: string; name?: string; kind?: "ttf" | "woff" | "otf" | "shx" }[]
  - OptionalcloseDocOnOpen?: boolean
    打开图纸时关闭当前文档（单文档打开模式）
    
    true（默认）: 打开新图纸时先关闭当前文档，节省内存
    
    新建文档不受影响，可以正常增加文档数量
    
    false: 打开新图纸时保留当前文档（传统方式）
  - Optionalplugins?: PluginConfig[]
    插件配置列表 - 启动时自动加载的插件
    
    Example
    plugins: [ { url: '/plugins/find-replace/plugin.js' }, { url: 'https://example.com/my-plugin.js', cssUrl: 'https://example.com/my-plugin.css' } ]
  - OptionalpluginMarketUrl?: string
    服务端插件市场地址
    
    访问此地址可获取服务端插件市场的插件列表（JSON格式）。自动加载的插件会在程序启动时自动下载并加载。
    
    Example
    pluginMarketUrl: "http://127.0.0.1:8082/plugins.json"
  - OptionaldocUrl?: string
    官方文档地址
    
    点击顶栏右侧的文档按钮时打开此地址。默认为 https://www.vjmap.com
    
    Example
    docUrl: "https://www.vjmap.com/docs"
  - OptionalsidebarStyle?: "left" | "right" | "none" | "both"
    侧边栏样式
    
    控制侧边栏的初始显示位置：
    
    "both": 左右两侧都显示
    
    "left": 只显示左侧
    
    "right": 只显示右侧（默认）
    
    "none": 不显示侧边栏
    
    Example
    sidebarStyle: "none" // 初始不显示侧边栏
  - OptionalviewMode?: "full" | "viewer"
    视图模式
    
    控制 UI 组件的显示：
    
    "full": 完整模式，显示所有 UI 组件（默认）
    
    "viewer": 查看模式，只显示绘图区域，隐藏菜单、工具栏、命令行等
    
    viewer 模式适用于只需要查看和选择实体的场景，可通过 SDK 获取选中实体信息。
    
    Example
    viewMode: "viewer" // 只显示绘图区域
  - OptionalshowMenuBar?: boolean
    是否显示菜单栏（细粒度控制）默认 true。设为 false 时隐藏菜单栏。
  - OptionalshowToolBar?: boolean
    是否显示工具栏/Ribbon（细粒度控制）默认 true。设为 false 时隐藏工具栏。
  - OptionalshowDocBar?: boolean
    是否显示文档栏（细粒度控制）默认 true。设为 false 时隐藏文档标签栏。
  - OptionalshowCoordsBar?: boolean
    是否显示坐标栏（细粒度控制）默认 true。设为 false 时隐藏坐标栏。
  - OptionalshowCommandLine?: boolean
    是否显示命令行（细粒度控制）默认 true。设为 false 时隐藏命令行。
  - OptionalshowBottomBar?: boolean
    是否显示底部状态栏（细粒度控制）默认 true。设为 false 时隐藏底部状态栏。
  - OptionalenableContextMenu?: boolean
    是否启用右键菜单（细粒度控制）默认 true。设为 false 时禁用右键菜单。 viewer 模式下默认禁用。
  - OptionalshowGrips?: boolean
    是否显示选择夹点（细粒度控制）默认 true。设为 false 时选择实体后不显示夹点。 viewer 模式下默认禁用（防止通过夹点拖动修改实体）。
  - OptionalshowUcsIcon?: boolean
    是否显示左下角的坐标轴图标（UCS 图标）默认 true。设为 false 时隐藏左下角的坐标轴指示器。
  - OptionalshowAxis?: boolean
    是否显示图中绘制的坐标轴默认 true。设为 false 时隐藏图中绘制的坐标轴。
  - OptionalbackgroundAlpha?: number
    背景透明度 (0-1) 默认 1（不透明）。设为 0 可实现透明背景，用于图层叠加场景。
  - OptionalshowCrosshair?: boolean
    是否显示十字光标默认 true。设为 false 时隐藏十字光标和拾取框。
  - OptionaldisablePointerEvents?: boolean
    是否禁用鼠标事件（允许事件穿透）默认 false。设为 true 时 canvas 不接收鼠标事件，用于图层叠加场景。
  - OptionalthemeMode?: number
    主题模式 0=深色（默认），1=浅色。影响实体默认颜色等。
Returns MainView
Overrides LitElement.constructor
- Defined in ui/MainView.ts:325

Properties

`Static`properties

properties: { theme: { type: StringConstructor } } = ...

定义响应式属性 - 使用静态属性

这是 Lit 官方推荐的写法，会自动处理属性的响应式更新使用 query 来查询 DOM 元素

`Static`styles

styles: r = ...

定义样式 - 使用静态属性

theme

theme: string

pcanvas

pcanvas: any

editor

editor: any

splitterController

splitterController: any

panelController

panelController: any

autoComplete

autoComplete: any

contextMenu

contextMenu: any

sidePalettes

sidePalettes: any

container

container: any

pixiCanvasContainer

pixiCanvasContainer: any

commandLine

commandLine: any

docBar

docBar: any

menuBar

menuBar: any

ribbonBar

ribbonBar: any

documentTabs

documentTabs: any

toolBar: any

coordsBar

coordsBar: any

actBarLeft

actBarLeft: any

actBarRight

actBarRight: any

sidebarFrameLeft

sidebarFrameLeft: any

sidebarFrameRight

sidebarFrameRight: any

`Optional`fontsConfig

fontsConfig?: {
    path: string;
    name?: string;
    kind?: "ttf" | "woff" | "otf" | "shx";
}[]

`Optional`pluginsConfig

pluginsConfig?: PluginConfig[]

`Optional`pluginMarketUrl

pluginMarketUrl?: string

`Optional`sidebarStyleConfig

sidebarStyleConfig?: "left" | "right" | "none" | "both"

`Optional`viewModeConfig

viewModeConfig?: "full" | "viewer"

`Optional`showMenuBarConfig

showMenuBarConfig?: boolean

`Optional`showToolBarConfig

showToolBarConfig?: boolean

`Optional`showDocBarConfig

showDocBarConfig?: boolean

`Optional`showCoordsBarConfig

showCoordsBarConfig?: boolean

`Optional`showCommandLineConfig

showCommandLineConfig?: boolean

`Optional`showBottomBarConfig

showBottomBarConfig?: boolean

`Optional`enableContextMenuConfig

enableContextMenuConfig?: boolean

`Optional`showGripsConfig

showGripsConfig?: boolean

`Optional`showUcsIconConfig

showUcsIconConfig?: boolean

`Optional`showAxisConfig

showAxisConfig?: boolean

`Optional`backgroundAlphaConfig

backgroundAlphaConfig?: number

`Optional`showCrosshairConfig

showCrosshairConfig?: boolean

`Optional`disablePointerEventsConfig

disablePointerEventsConfig?: boolean

`Optional`themeModeConfig

themeModeConfig?: number

`Static` `Readonly`URL_PARAM_PREFIX

URL_PARAM_PREFIX: "vcad_" = 'vcad_'

URL 参数前缀，用于防止与其他系统参数冲突

`Static` `Readonly`URL_PARAMS

URL_PARAMS: {
    MAPID: string;
    VERSION: string;
    BRANCH: string;
    PATCH: string;
    READONLY: string;
    TILE: string;
} = ...

URL 参数名称常量

Type Declaration

MAPID: string
图纸 ID (mapid)
VERSION: string
版本号，可选，默认最新版本
BRANCH: string
分支名称，可选，默认 main
PATCH: string
Patch ID，可选，默认 base
READONLY: string
是否只读打开，可选，默认 false
TILE: string
是否以瓦片方式打开，可选，默认 false

renderRoot

renderRoot: any

Accessors

`Static`observedAttributes

get observedAttributes(): any[]
Returns any[]
Inherited from LitElement.observedAttributes
- Defined in vendor/lit-element-base.ts:103

updateComplete

get updateComplete(): any
Returns any
Inherited from LitElement.updateComplete
- Defined in vendor/lit-element-base.ts:306

Methods

clearFileData

clearFileData(): void
清空文件数据

Returns void
- Defined in ui/MainView.ts:484

setTheme

setTheme(t: string): void
设置主题
Parameters
- t: string
  主题名称
Returns void
- Defined in ui/MainView.ts:490

connectedCallback

connectedCallback(): void
连接回调

Returns void
Overrides LitElement.connectedCallback
- Defined in ui/MainView.ts:497

firstUpdated

firstUpdated(): Promise<void>
首次更新后回调

Returns Promise<void>
Overrides LitElement.firstUpdated
- Defined in ui/MainView.ts:504

onLoad

onLoad(): Promise<void>
等待视图初始化完成

在初始化完成后返回，可用于替代 DocumentCreated 事件监听。初始化包括：画布创建、WASM 加载、插件加载、URL 参数处理等。

Returns Promise<void>
初始化完成后 resolve
Example
```
const cadView = new MainView({ ... });
initCadContainer("map", cadView);

// 等待初始化完成
await cadView.onLoad();

// 现在可以直接操作 CAD
const line = new LineEnt(new Point2D(0, 0), new Point2D(100, 100));
Engine.pcanvas.addLine(line);
```
- Defined in ui/MainView.ts:671

loadPlugins

loadPlugins(plugins: PluginConfig[]): Promise<void>
加载插件列表
Parameters
- plugins: PluginConfig[]
  插件配置列表
Returns Promise<void>
- Defined in ui/MainView.ts:959

loadPlugin

loadPlugin(url: string, cssUrl?: string): Promise<string>
动态加载单个插件
Parameters
- url: string
  插件JS文件URL
- OptionalcssUrl: string
  插件CSS文件URL（可选）
Returns Promise<string>
插件ID
- Defined in ui/MainView.ts:980

unloadPlugin

unloadPlugin(pluginId: string): Promise<void>
卸载插件
Parameters
- pluginId: string
  插件ID
Returns Promise<void>
- Defined in ui/MainView.ts:989

initEventListerners

initEventListerners(): void
初始化事件监听器

Returns void
- Defined in ui/MainView.ts:1291

hideUI

hideUI(): void
隐藏UI元素

Returns void
- Defined in ui/MainView.ts:1310

commandLineInput_callback

commandLineInput_callback(t: any): void
命令行输入回调
Parameters
- t: any
  事件对象
Returns void
- Defined in ui/MainView.ts:1333

docChanged_callback

docChanged_callback(t: any): Promise<void>
文档变更回调
Parameters
- t: any
  事件对象
Returns Promise<void>
- Defined in ui/MainView.ts:1362

newDocument

newDocument(): any
新建文档

Returns any
新文档对象
- Defined in ui/MainView.ts:1375

download

download(t: string): Promise<void>
下载文档
Parameters
- t: string
  文件名
Returns Promise<void>
- Defined in ui/MainView.ts:1389

saveAsDocument

saveAsDocument(t: any, e: string, i?: string): Promise<void>
另存为文档
Parameters
- t: any
  文档对象
- e: string
  文件名
- i: string = ""
  文件路径
Returns Promise<void>
- Defined in ui/MainView.ts:1411

saveAsDocumentClone

saveAsDocumentClone(t: any, e: string, i?: string): Promise<void>
克隆另存为文档
Parameters
- t: any
  源文档对象
- e: string
  文件名
- i: string = ""
  文件路径
Returns Promise<void>
- Defined in ui/MainView.ts:1426

openOrActiveDocument

openOrActiveDocument(t: string): Promise<boolean>
打开或激活文档
Parameters
- t: string
  文档全名
Returns Promise<boolean>
是否成功
- Defined in ui/MainView.ts:1448

openDoc

openDoc(t: any): Promise<void>
打开文档
Parameters
- t: any
  文档对象
Returns Promise<void>
- Defined in ui/MainView.ts:1463

openDbDoc

openDbDoc(t: File, e: any, i?: boolean): Promise<boolean>
打开数据库文档
Parameters
- t: File
  文件对象
- e: any
  数据库数据
- i: boolean = false
  是否只读
Returns Promise<boolean>
是否成功打开
- Defined in ui/MainView.ts:1525

openDocumentByFile

openDocumentByFile(t: File, e?: boolean): Promise<void>
通过文件打开文档
Parameters
- t: File
  文件对象
- e: boolean = false
  是否只读
Returns Promise<void>
- Defined in ui/MainView.ts:1616

readFileToDbDoc

readFileToDbDoc(t: File): Promise<any>
读取文件为数据库文档
Parameters
- t: File
  文件对象
Returns Promise<any>
数据库数据
- Defined in ui/MainView.ts:1626

startWatchCoords

startWatchCoords(): void
开始监听坐标

Returns void
- Defined in ui/MainView.ts:1645

pcanvasMouseMove_callback

pcanvasMouseMove_callback(t: any): void
画布鼠标移动回调
Parameters
- t: any
  事件对象
Returns void
- Defined in ui/MainView.ts:1658

closeByName

closeByName(t: string): void
根据名称关闭文档
Parameters
- t: string
  文档名称
Returns void
- Defined in ui/MainView.ts:1698

closeById

closeById(t: string): void
根据ID关闭文档
Parameters
- t: string
  文档ID
Returns void
- Defined in ui/MainView.ts:1744

close

close(): void
关闭当前文档

Returns void
- Defined in ui/MainView.ts:1788

render

render(): any
渲染方法

Returns any
渲染结果
Overrides LitElement.render
- Defined in ui/MainView.ts:1971

`Static`addInitializer

addInitializer(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.addInitializer
- Defined in vendor/lit-element-base.ts:100

`Static`createProperty

createProperty(
    t: any,
    e?: {
        attribute: boolean;
        type: StringConstructor;
        converter: {
            toAttribute(t: any, e: any): any;
            fromAttribute(t: any, e: any): any;
        };
        reflect: boolean;
        hasChanged: (t: any, e: any) => boolean;
    },
): void
Parameters
- t: any
- e: {
      attribute: boolean;
      type: StringConstructor;
      converter: {
          toAttribute(t: any, e: any): any;
          fromAttribute(t: any, e: any): any;
      };
      reflect: boolean;
      hasChanged: (t: any, e: any) => boolean;
  } = y
Returns void
Inherited from LitElement.createProperty
- Defined in vendor/lit-element-base.ts:106

`Static`getPropertyDescriptor

getPropertyDescriptor(
    t: any,
    e: any,
    s: any,
): {
    get(): any;
    set(e: any): void;
    configurable: boolean;
    enumerable: boolean;
}
Parameters
- t: any
- e: any
- s: any
Returns { get(): any; set(e: any): void; configurable: boolean; enumerable: boolean }
Inherited from LitElement.getPropertyDescriptor
- Defined in vendor/lit-element-base.ts:113

`Static`getPropertyOptions

getPropertyOptions(t: any): any
Parameters
- t: any
Returns any
Inherited from LitElement.getPropertyOptions
- Defined in vendor/lit-element-base.ts:137

`Static`_$Ei

_$Ei(): void
Returns void
Inherited from LitElement._$Ei
- Defined in vendor/lit-element-base.ts:140

`Static`finalize

finalize(): void
Returns void
Inherited from LitElement.finalize
- Defined in vendor/lit-element-base.ts:145

`Static`finalizeStyles

finalizeStyles(t: any): any[]
Parameters
- t: any
Returns any[]
Inherited from LitElement.finalizeStyles
- Defined in vendor/lit-element-base.ts:165

`Static`_$Eu

_$Eu(t: any, e: any): string
Parameters
- t: any
- e: any
Returns string
Inherited from LitElement._$Eu
- Defined in vendor/lit-element-base.ts:173

_$Ev

_$Ev(): void
Returns void
Inherited from LitElement._$Ev
- Defined in vendor/lit-element-base.ts:180

addController

addController(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.addController
- Defined in vendor/lit-element-base.ts:184

removeController

removeController(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.removeController
- Defined in vendor/lit-element-base.ts:188

_$E_

_$E_(): void
Returns void
Inherited from LitElement._$E_
- Defined in vendor/lit-element-base.ts:192

enableUpdating

enableUpdating(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.enableUpdating
- Defined in vendor/lit-element-base.ts:217

attributeChangedCallback

attributeChangedCallback(t: any, e: any, s: any): void
Parameters
- t: any
- e: any
- s: any
Returns void
Inherited from LitElement.attributeChangedCallback
- Defined in vendor/lit-element-base.ts:225

_$EC

_$EC(t: any, e: any): void
Parameters
- t: any
- e: any
Returns void
Inherited from LitElement._$EC
- Defined in vendor/lit-element-base.ts:228

_$AK

_$AK(t: any, e: any): void
Parameters
- t: any
- e: any
Returns void
Inherited from LitElement._$AK
- Defined in vendor/lit-element-base.ts:237

requestUpdate

requestUpdate(t?: any, e?: any, s?: any): void
Parameters
- Optionalt: any
- Optionale: any
- Optionals: any
Returns void
Inherited from LitElement.requestUpdate
- Defined in vendor/lit-element-base.ts:249

P

P(t: any, e: any, s: any): void
Parameters
- t: any
- e: any
- s: any
Returns void
Inherited from LitElement.P
- Defined in vendor/lit-element-base.ts:255

_$ET

_$ET(): Promise<boolean>
Returns Promise<boolean>
Inherited from LitElement._$ET
- Defined in vendor/lit-element-base.ts:258

scheduleUpdate

scheduleUpdate(): void
Returns void
Inherited from LitElement.scheduleUpdate
- Defined in vendor/lit-element-base.ts:268

performUpdate

performUpdate(): void
Returns void
Inherited from LitElement.performUpdate
- Defined in vendor/lit-element-base.ts:271

willUpdate

willUpdate(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.willUpdate
- Defined in vendor/lit-element-base.ts:295

_$AE

_$AE(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement._$AE
- Defined in vendor/lit-element-base.ts:296

_$EU

_$EU(): void
Returns void
Inherited from LitElement._$EU
- Defined in vendor/lit-element-base.ts:303

getUpdateComplete

getUpdateComplete(): any
Returns any
Inherited from LitElement.getUpdateComplete
- Defined in vendor/lit-element-base.ts:309

shouldUpdate

shouldUpdate(t: any): boolean
Parameters
- t: any
Returns boolean
Inherited from LitElement.shouldUpdate
- Defined in vendor/lit-element-base.ts:312

updated

updated(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.updated
- Defined in vendor/lit-element-base.ts:318

createRenderRoot

createRenderRoot(): ShadowRoot
Returns ShadowRoot
Inherited from LitElement.createRenderRoot
- Defined in vendor/lit-element-base.ts:640

update

update(t: any): void
Parameters
- t: any
Returns void
Inherited from LitElement.update
- Defined in vendor/lit-element-base.ts:645

disconnectedCallback

disconnectedCallback(): void
Returns void
Inherited from LitElement.disconnectedCallback
- Defined in vendor/lit-element-base.ts:661

Class MainView

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalappname?: string

Optionalversion?: string

OptionalwasmServiceUrl?: string

OptionalserviceUrl?: string

Optionalworkspace?: string

OptionalaccessToken?: string

OptionalaccessKey?: string

Optionalfonts?: { path: string; name?: string; kind?: "ttf" | "woff" | "otf" | "shx" }[]

OptionalcloseDocOnOpen?: boolean

Optionalplugins?: PluginConfig[]

Example

OptionalpluginMarketUrl?: string

Example

OptionaldocUrl?: string

Example

OptionalsidebarStyle?: "left" | "right" | "none" | "both"

Example

OptionalviewMode?: "full" | "viewer"

Example

OptionalshowMenuBar?: boolean

OptionalshowToolBar?: boolean

OptionalshowDocBar?: boolean

OptionalshowCoordsBar?: boolean

OptionalshowCommandLine?: boolean

OptionalshowBottomBar?: boolean

OptionalenableContextMenu?: boolean

OptionalshowGrips?: boolean

OptionalshowUcsIcon?: boolean

OptionalshowAxis?: boolean

OptionalbackgroundAlpha?: number

OptionalshowCrosshair?: boolean

OptionaldisablePointerEvents?: boolean

OptionalthemeMode?: number

Returns MainView

Properties

Staticproperties

Staticstyles

theme

pcanvas

editor

splitterController

panelController

autoComplete

contextMenu

sidePalettes

container

pixiCanvasContainer

commandLine

docBar

menuBar

ribbonBar

documentTabs

toolBar

coordsBar

actBarLeft

actBarRight

sidebarFrameLeft

sidebarFrameRight

OptionalfontsConfig

OptionalpluginsConfig

OptionalpluginMarketUrl

OptionalsidebarStyleConfig

OptionalviewModeConfig

OptionalshowMenuBarConfig

OptionalshowToolBarConfig

OptionalshowDocBarConfig

OptionalshowCoordsBarConfig

OptionalshowCommandLineConfig

OptionalshowBottomBarConfig

OptionalenableContextMenuConfig

`Optional`appname?: string

`Optional`version?: string

`Optional`wasmServiceUrl?: string

`Optional`serviceUrl?: string

`Optional`workspace?: string

`Optional`accessToken?: string

`Optional`accessKey?: string

`Optional`fonts?: { path: string; name?: string; kind?: "ttf" | "woff" | "otf" | "shx" }[]

`Optional`closeDocOnOpen?: boolean

`Optional`plugins?: PluginConfig[]

`Optional`pluginMarketUrl?: string

`Optional`docUrl?: string

`Optional`sidebarStyle?: "left" | "right" | "none" | "both"

`Optional`viewMode?: "full" | "viewer"

`Optional`showMenuBar?: boolean

`Optional`showToolBar?: boolean

`Optional`showDocBar?: boolean

`Optional`showCoordsBar?: boolean

`Optional`showCommandLine?: boolean

`Optional`showBottomBar?: boolean

`Optional`enableContextMenu?: boolean

`Optional`showGrips?: boolean

`Optional`showUcsIcon?: boolean

`Optional`showAxis?: boolean

`Optional`backgroundAlpha?: number

`Optional`showCrosshair?: boolean

`Optional`disablePointerEvents?: boolean

`Optional`themeMode?: number

`Static`properties

`Static`styles

`Optional`fontsConfig

`Optional`pluginsConfig

`Optional`pluginMarketUrl

`Optional`sidebarStyleConfig

`Optional`viewModeConfig

`Optional`showMenuBarConfig

`Optional`showToolBarConfig

`Optional`showDocBarConfig

`Optional`showCoordsBarConfig

`Optional`showCommandLineConfig

`Optional`showBottomBarConfig

`Optional`enableContextMenuConfig

`Optional`showGripsConfig

`Optional`showUcsIconConfig

`Optional`showAxisConfig

`Optional`backgroundAlphaConfig

`Optional`showCrosshairConfig

`Optional`disablePointerEventsConfig

`Optional`themeModeConfig

`Static` `Readonly`URL_PARAM_PREFIX

`Static` `Readonly`URL_PARAMS

`Static`observedAttributes