---
title: Class: DbDocument
source: https://vjmap.com/doc/Class_DbDocument.html
---

# Class: DbDocument

[default](#modulesdefaultmd).DbDocument

`DbDocument` 地图数据库文档.

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [blocks](#blocks)
- [dimStyles](#dimstyles)
- [entitys](#entitys)
- [environment](#environment)
- [from](#from)
- [isClearFromDb](#isclearfromdb)
- [isRenameBlockNameIfExist](#isrenameblocknameifexist)
- [layers](#layers)
- [linetypes](#linetypes)
- [pickEntitys](#pickentitys)
- [pickExpr](#pickexpr)
- [pickLayers](#picklayers)
- [textStyles](#textstyles)

#### Methods

- [appendBlock](#appendblock)
- [appendDimStyle](#appenddimstyle)
- [appendEntity](#appendentity)
- [appendLayer](#appendlayer)
- [appendLinetype](#appendlinetype)
- [appendTextStyle](#appendtextstyle)
- [toDoc](#todoc)

### Constructors

#### constructor

\+ **new DbDocument**(`prop?`: [*IDbDocument*](#interfacesdefaultidbdocumentmd)): [*DbDocument*](#classesdefaultdbdocumentmd)

构造函数

##### Parameters

| Name | Type | Default value |
| :------ | :------ | :------ |
| `prop` | [*IDbDocument*](#interfacesdefaultidbdocumentmd) | {} |

**Returns:** [*DbDocument*](#classesdefaultdbdocumentmd)

### Properties

#### blocks

• `Optional` **blocks**: [*IDbBlock*](#interfacesdefaultidbblockmd)[]

块定义.

___

#### dimStyles

• `Optional` **dimStyles**: [*IDbDimStyle*](#interfacesdefaultidbdimstylemd)[]

标注样式.

___

#### entitys

• `Optional` **entitys**: [*IDbEntity*](#interfacesdefaultidbentitymd)[]

实体集.

___

#### environment

• `Optional` **environment**: *Record*<string, any\>

文档环境，用于设置是否显示线宽等设置, 设置线宽为 LWDISPLAY ,true显示或 false不显示线宽

___

#### from

• `Optional` **from**: *string*

来源于哪个图，会在此图的上面进行修改或新增删除，格式如 形式为 mapid/version,如 exam/v1 .

___

#### isClearFromDb

• `Optional` **isClearFromDb**: *boolean*

___

#### isRenameBlockNameIfExist

• `Optional` **isRenameBlockNameIfExist**: *boolean*

来源于其他图的实体时，如果块定义重复，则自动重命名 ，默认true

___

#### layers

• `Optional` **layers**: [*IDbLayer*](#interfacesdefaultidblayermd)[]

图层集.

___

#### linetypes

• `Optional` **linetypes**: [*IDbLinetype*](#interfacesdefaultidblinetypemd)[]

线型.

___

#### pickEntitys

• `Optional` **pickEntitys**: *string*[]

来源于哪个图时有效，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示

___

#### pickExpr

• `Optional` **pickExpr**: *string*

来源于哪个图时有效，使用表达式，表示从此图中选择指定的实体ID，不在指定的实体ID将不会显示 结果与pickEntitys的取并

___

#### pickLayers

• `Optional` **pickLayers**: *string*[]

来源于哪个图时有效，表示从此图中选择指定的图层，不在指定的图层将不会显示

___

#### textStyles

• `Optional` **textStyles**: [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)[]

文字样式.

### Methods

#### appendBlock

▸ **appendBlock**(`block`: [*IDbBlock*](#interfacesdefaultidbblockmd) \| [*IDbBlock*](#interfacesdefaultidbblockmd)[]): *void*

增加块

##### Parameters

| Name | Type |
| :------ | :------ |
| `block` | [*IDbBlock*](#interfacesdefaultidbblockmd) \| [*IDbBlock*](#interfacesdefaultidbblockmd)[] |

**Returns:** *void*

___

#### appendDimStyle

▸ **appendDimStyle**(`dimStyle`: [*IDbDimStyle*](#interfacesdefaultidbdimstylemd) \| [*IDbDimStyle*](#interfacesdefaultidbdimstylemd)[]): *void*

增加标注样式

##### Parameters

| Name | Type |
| :------ | :------ |
| `dimStyle` | [*IDbDimStyle*](#interfacesdefaultidbdimstylemd) \| [*IDbDimStyle*](#interfacesdefaultidbdimstylemd)[] |

**Returns:** *void*

___

#### appendEntity

▸ **appendEntity**(`entity`: [*IDbEntity*](#interfacesdefaultidbentitymd) \| [*IDbEntity*](#interfacesdefaultidbentitymd)[]): *void*

增加实体

##### Parameters

| Name | Type |
| :------ | :------ |
| `entity` | [*IDbEntity*](#interfacesdefaultidbentitymd) \| [*IDbEntity*](#interfacesdefaultidbentitymd)[] |

**Returns:** *void*

___

#### appendLayer

▸ **appendLayer**(`layer`: [*IDbLayer*](#interfacesdefaultidblayermd) \| [*IDbLayer*](#interfacesdefaultidblayermd)[]): *void*

增加图层

##### Parameters

| Name | Type |
| :------ | :------ |
| `layer` | [*IDbLayer*](#interfacesdefaultidblayermd) \| [*IDbLayer*](#interfacesdefaultidblayermd)[] |

**Returns:** *void*

___

#### appendLinetype

▸ **appendLinetype**(`linetype`: [*IDbLinetype*](#interfacesdefaultidblinetypemd) \| [*IDbLinetype*](#interfacesdefaultidblinetypemd)[]): *void*

增加线型

##### Parameters

| Name | Type |
| :------ | :------ |
| `linetype` | [*IDbLinetype*](#interfacesdefaultidblinetypemd) \| [*IDbLinetype*](#interfacesdefaultidblinetypemd)[] |

**Returns:** *void*

___

#### appendTextStyle

▸ **appendTextStyle**(`textStyle`: [*IDbTextStyle*](#interfacesdefaultidbtextstylemd) \| [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)[]): *void*

增加样式样式

##### Parameters

| Name | Type |
| :------ | :------ |
| `textStyle` | [*IDbTextStyle*](#interfacesdefaultidbtextstylemd) \| [*IDbTextStyle*](#interfacesdefaultidbtextstylemd)[] |

**Returns:** *void*

___

#### toDoc

▸ **toDoc**(`content?`: *string*): *string*

转成文档字符串

##### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `content?` | *string* | 如果传入了内容，则以content为主。json格式 |

**Returns:** *string*


<a name="classesdefaultdbellipsemd"></a>

[vjmap](#readmemd) / [Exports](#modulesmd) / [default](#modulesdefaultmd) / DbEllipse