---
title: Class: DbWipeout
source: https://vjmap.com/en/doc/Class_DbWipeout.html
---

# Class: DbWipeout

[default](#modulesdefaultmd).DbWipeout

`DbWipeout` 遮罩实体.

### Hierarchy

- [*DbRasterImage*](#classesdefaultdbrasterimagemd)

  ↳ **DbWipeout**

### Table of contents

#### Constructors

- [constructor](#constructor)

#### Properties

- [alpha](#alpha)
- [brightness](#brightness)
- [cloneFromDb](#clonefromdb)
- [cloneObjectId](#cloneobjectid)
- [color](#color)
- [colorIndex](#colorindex)
- [heightRatio](#heightratio)
- [imageDisplayOptClip](#imagedisplayoptclip)
- [imageDisplayOptShow](#imagedisplayoptshow)
- [imageDisplayOptShowUnAligned](#imagedisplayoptshowunaligned)
- [imageDisplayOptTransparent](#imagedisplayopttransparent)
- [layer](#layer)
- [lineWidth](#linewidth)
- [linetype](#linetype)
- [linetypeScale](#linetypescale)
- [matrix](#matrix)
- [pixelHeight](#pixelheight)
- [pixelWidth](#pixelwidth)
- [points](#points)
- [position](#position)
- [sourceHttpUrl](#sourcehttpurl)
- [typename](#typename)
- [units](#units)
- [visibility](#visibility)
- [widthRatio](#widthratio)
- [xPelsPerUnit](#xpelsperunit)
- [xdata](#xdata)
- [yPelsPerUnit](#ypelsperunit)

### Constructors

#### constructor

\+ **new DbWipeout**(`prop?`: [*IDbWipeout*](#interfacesdefaultidbwipeoutmd)): [*DbWipeout*](#classesdefaultdbwipeoutmd)

构造函数

##### Parameters

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

**Returns:** [*DbWipeout*](#classesdefaultdbwipeoutmd)

Overrides: [DbRasterImage](#classesdefaultdbrasterimagemd)

### Properties

#### alpha

• `Optional` **alpha**: *number*

透明度. [0-255][0完全透明,255完全不透明]

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[alpha](#alpha)

___

#### brightness

• `Optional` **brightness**: *number*

明亮度 [0.0 .. 100.0]

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[brightness](#brightness)

___

#### cloneFromDb

• `Optional` **cloneFromDb**: *string*

克隆的实体ID来源的图形，如为空，则取DbDocument中from的图形。也可以指定另外的图形

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[cloneFromDb](#clonefromdb)

___

#### cloneObjectId

• `Optional` **cloneObjectId**: *string*

克隆的实体ID，DbDocument有from图形来源字段时有效.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[cloneObjectId](#cloneobjectid)

___

#### color

• `Optional` **color**: *number*

颜色.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[color](#color)

___

#### colorIndex

• `Optional` **colorIndex**: *number*

颜色索引. 0 随块. 1 Red.  2 Yellow. 3   Green.  4 Cyan.  5  Blue. 6   Magenta. 256 表示随层

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[colorIndex](#colorindex)

___

#### heightRatio

• `Optional` **heightRatio**: *number*

高比例..

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[heightRatio](#heightratio)

___

#### imageDisplayOptClip

• `Optional` **imageDisplayOptClip**: *boolean*

是否裁剪.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptClip](#imagedisplayoptclip)

___

#### imageDisplayOptShow

• `Optional` **imageDisplayOptShow**: *boolean*

是否显示.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptShow](#imagedisplayoptshow)

___

#### imageDisplayOptShowUnAligned

• `Optional` **imageDisplayOptShowUnAligned**: *boolean*

是否对齐.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptShowUnAligned](#imagedisplayoptshowunaligned)

___

#### imageDisplayOptTransparent

• `Optional` **imageDisplayOptTransparent**: *boolean*

是否透明.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[imageDisplayOptTransparent](#imagedisplayopttransparent)

___

#### layer

• `Optional` **layer**: *string*

图层.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[layer](#layer)

___

#### lineWidth

• `Optional` **lineWidth**: *number*

线宽.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[lineWidth](#linewidth)

___

#### linetype

• `Optional` **linetype**: *string*

线型.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[linetype](#linetype)

___

#### linetypeScale

• `Optional` **linetypeScale**: *number*

线型比例.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[linetypeScale](#linetypescale)

___

#### matrix

• `Optional` **matrix**: [*IDbMatrixOp*](#interfacesdefaultidbmatrixopmd)[]

矩阵.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[matrix](#matrix)

___

#### pixelHeight

• `Optional` **pixelHeight**: *number*

源图片高.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[pixelHeight](#pixelheight)

___

#### pixelWidth

• `Optional` **pixelWidth**: *number*

源图片宽.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[pixelWidth](#pixelwidth)

___

#### points

• `Optional` **points**: [*number*, *number*, *undefined* \| *number*][]

坐标.

___

#### position

• `Optional` **position**: [*number*, *number*, *undefined* \| *number*]

位置.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[position](#position)

___

#### sourceHttpUrl

• `Optional` **sourceHttpUrl**: *string*

图片url地址.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[sourceHttpUrl](#sourcehttpurl)

___

#### typename

• `Optional` **typename**: *string*

类型.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[typename](#typename)

___

#### units

• `Optional` **units**: [*kNone*](#knone) \| [*kMillimeter*](#kmillimeter) \| [*kCentimeter*](#kcentimeter) \| [*kMeter*](#kmeter) \| [*kKilometer*](#kkilometer) \| [*kInch*](#kinch) \| [*kFoot*](#kfoot) \| [*kYard*](#kyard) \| [*kMile*](#kmile) \| [*kMicroinches*](#kmicroinches) \| [*kMils*](#kmils) \| [*kAngstroms*](#kangstroms) \| [*kNanometers*](#knanometers) \| [*kMicrons*](#kmicrons) \| [*kDecimeters*](#kdecimeters) \| [*kDekameters*](#kdekameters) \| [*kHectometers*](#khectometers) \| [*kGigameters*](#kgigameters) \| [*kAstronomical*](#kastronomical) \| [*kLightYears*](#klightyears) \| [*kParsecs*](#kparsecs)

单位.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[units](#units)

___

#### visibility

• `Optional` **visibility**: *boolean*

可见.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[visibility](#visibility)

___

#### widthRatio

• `Optional` **widthRatio**: *number*

宽比例.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[widthRatio](#widthratio)

___

#### xPelsPerUnit

• `Optional` **xPelsPerUnit**: *number*

x轴每像素代表长度.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[xPelsPerUnit](#xpelsperunit)

___

#### xdata

• `Optional` **xdata**: *string*

扩展数据.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[xdata](#xdata)

___

#### yPelsPerUnit

• `Optional` **yPelsPerUnit**: *number*

y轴每像素代表长度.

Inherited from: [DbRasterImage](#classesdefaultdbrasterimagemd).[yPelsPerUnit](#ypelsperunit)


<a name="classesdefaultdecklayermd"></a>

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