
## MsoFormatPicture class

Represents the picture format.

```javascript
class MsoFormatPicture;
```


## Properties

| Property | Type | Description |
| --- | --- | --- |
| [topCropInch](#topCropInch--)| number | Represents the location of the top of the crop rectangle expressed, in unit of inches. |
| [bottomCropInch](#bottomCropInch--)| number | Represents the location of the bottom of the crop rectangle expressed, in unit of inches. |
| [leftCropInch](#leftCropInch--)| number | Represents the location of the left of the crop rectangle expressed, in unit of inches. |
| [rightCropInch](#rightCropInch--)| number | Represents the location of the right of the crop rectangle expressed, in unit of inches. |
| [topCrop](#topCrop--)| number | Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height. |
| [bottomCrop](#bottomCrop--)| number | Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height. |
| [leftCrop](#leftCrop--)| number | Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width. |
| [rightCrop](#rightCrop--)| number | Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width. |
| [transparency](#transparency--)| number | Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| [transparentColor](#transparentColor--)| CellsColor | Gets and sets the transparent color of the picture. |
| [contrast](#contrast--)| number | Represents the contrast modification for the picture.in unit of percentage. |
| [brightness](#brightness--)| number | Represents the brightness modification for the picture in unit of percentage. |
| [gamma](#gamma--)| number | Represents gamma of the picture. |
| [isBiLevel](#isBiLevel--)| boolean | Indicates whether this picture should display in two-color black and white. |
| [isGray](#isGray--)| boolean | Indicates whether this picture should display in grayscale. |

## Methods

| Method | Description |
| --- | --- |
| [getTopCropInch()](#getTopCropInch--)| <b>@deprecated.</b> Please use the 'topCropInch' property instead. Represents the location of the top of the crop rectangle expressed, in unit of inches. |
| [setTopCropInch(number)](#setTopCropInch-number-)| <b>@deprecated.</b> Please use the 'topCropInch' property instead. Represents the location of the top of the crop rectangle expressed, in unit of inches. |
| [getBottomCropInch()](#getBottomCropInch--)| <b>@deprecated.</b> Please use the 'bottomCropInch' property instead. Represents the location of the bottom of the crop rectangle expressed, in unit of inches. |
| [setBottomCropInch(number)](#setBottomCropInch-number-)| <b>@deprecated.</b> Please use the 'bottomCropInch' property instead. Represents the location of the bottom of the crop rectangle expressed, in unit of inches. |
| [getLeftCropInch()](#getLeftCropInch--)| <b>@deprecated.</b> Please use the 'leftCropInch' property instead. Represents the location of the left of the crop rectangle expressed, in unit of inches. |
| [setLeftCropInch(number)](#setLeftCropInch-number-)| <b>@deprecated.</b> Please use the 'leftCropInch' property instead. Represents the location of the left of the crop rectangle expressed, in unit of inches. |
| [getRightCropInch()](#getRightCropInch--)| <b>@deprecated.</b> Please use the 'rightCropInch' property instead. Represents the location of the right of the crop rectangle expressed, in unit of inches. |
| [setRightCropInch(number)](#setRightCropInch-number-)| <b>@deprecated.</b> Please use the 'rightCropInch' property instead. Represents the location of the right of the crop rectangle expressed, in unit of inches. |
| [getTopCrop()](#getTopCrop--)| <b>@deprecated.</b> Please use the 'topCrop' property instead. Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height. |
| [setTopCrop(number)](#setTopCrop-number-)| <b>@deprecated.</b> Please use the 'topCrop' property instead. Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height. |
| [getBottomCrop()](#getBottomCrop--)| <b>@deprecated.</b> Please use the 'bottomCrop' property instead. Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height. |
| [setBottomCrop(number)](#setBottomCrop-number-)| <b>@deprecated.</b> Please use the 'bottomCrop' property instead. Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height. |
| [getLeftCrop()](#getLeftCrop--)| <b>@deprecated.</b> Please use the 'leftCrop' property instead. Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width. |
| [setLeftCrop(number)](#setLeftCrop-number-)| <b>@deprecated.</b> Please use the 'leftCrop' property instead. Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width. |
| [getRightCrop()](#getRightCrop--)| <b>@deprecated.</b> Please use the 'rightCrop' property instead. Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width. |
| [setRightCrop(number)](#setRightCrop-number-)| <b>@deprecated.</b> Please use the 'rightCrop' property instead. Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width. |
| [getTransparency()](#getTransparency--)| <b>@deprecated.</b> Please use the 'transparency' property instead. Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| [setTransparency(number)](#setTransparency-number-)| <b>@deprecated.</b> Please use the 'transparency' property instead. Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear). |
| [getTransparentColor()](#getTransparentColor--)| <b>@deprecated.</b> Please use the 'transparentColor' property instead. Gets and sets the transparent color of the picture. |
| [setTransparentColor(CellsColor)](#setTransparentColor-cellscolor-)| <b>@deprecated.</b> Please use the 'transparentColor' property instead. Gets and sets the transparent color of the picture. |
| [getContrast()](#getContrast--)| <b>@deprecated.</b> Please use the 'contrast' property instead. Represents the contrast modification for the picture.in unit of percentage. |
| [setContrast(number)](#setContrast-number-)| <b>@deprecated.</b> Please use the 'contrast' property instead. Represents the contrast modification for the picture.in unit of percentage. |
| [getBrightness()](#getBrightness--)| <b>@deprecated.</b> Please use the 'brightness' property instead. Represents the brightness modification for the picture in unit of percentage. |
| [setBrightness(number)](#setBrightness-number-)| <b>@deprecated.</b> Please use the 'brightness' property instead. Represents the brightness modification for the picture in unit of percentage. |
| [getGamma()](#getGamma--)| <b>@deprecated.</b> Please use the 'gamma' property instead. Represents gamma of the picture. |
| [setGamma(number)](#setGamma-number-)| <b>@deprecated.</b> Please use the 'gamma' property instead. Represents gamma of the picture. |
| [isBiLevel()](#isBiLevel--)| <b>@deprecated.</b> Please use the 'isBiLevel' property instead. Indicates whether this picture should display in two-color black and white. |
| [setIsBiLevel(boolean)](#setIsBiLevel-boolean-)| <b>@deprecated.</b> Please use the 'isBiLevel' property instead. Indicates whether this picture should display in two-color black and white. |
| [isGray()](#isGray--)| <b>@deprecated.</b> Please use the 'isGray' property instead. Indicates whether this picture should display in grayscale. |
| [setIsGray(boolean)](#setIsGray-boolean-)| <b>@deprecated.</b> Please use the 'isGray' property instead. Indicates whether this picture should display in grayscale. |
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
| [getHashCode()](#getHashCode--)| Gets the hash code. |
| [equals(Object)](#equals-object-)|  |


### topCropInch {#topCropInch--}

Represents the location of the top of the crop rectangle expressed, in unit of inches.

```javascript
topCropInch : number;
```


### bottomCropInch {#bottomCropInch--}

Represents the location of the bottom of the crop rectangle expressed, in unit of inches.

```javascript
bottomCropInch : number;
```


### leftCropInch {#leftCropInch--}

Represents the location of the left of the crop rectangle expressed, in unit of inches.

```javascript
leftCropInch : number;
```


### rightCropInch {#rightCropInch--}

Represents the location of the right of the crop rectangle expressed, in unit of inches.

```javascript
rightCropInch : number;
```


### topCrop {#topCrop--}

Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height.

```javascript
topCrop : number;
```


### bottomCrop {#bottomCrop--}

Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height.

```javascript
bottomCrop : number;
```


### leftCrop {#leftCrop--}

Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width.

```javascript
leftCrop : number;
```


### rightCrop {#rightCrop--}

Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width.

```javascript
rightCrop : number;
```


### transparency {#transparency--}

Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

```javascript
transparency : number;
```


### transparentColor {#transparentColor--}

Gets and sets the transparent color of the picture.

```javascript
transparentColor : CellsColor;
```


### contrast {#contrast--}

Represents the contrast modification for the picture.in unit of percentage.

```javascript
contrast : number;
```


**Remarks**

It is between -100% and 100%. It works same as Excel 2007 or above version.

### brightness {#brightness--}

Represents the brightness modification for the picture in unit of percentage.

```javascript
brightness : number;
```


**Remarks**

It is between -100% and 100%. It works same as Excel 2007 or above version.

### gamma {#gamma--}

Represents gamma of the picture.

```javascript
gamma : number;
```


### isBiLevel {#isBiLevel--}

Indicates whether this picture should display in two-color black and white.

```javascript
isBiLevel : boolean;
```


### isGray {#isGray--}

Indicates whether this picture should display in grayscale.

```javascript
isGray : boolean;
```


### getTopCropInch() {#getTopCropInch--}

<b>@deprecated.</b> Please use the 'topCropInch' property instead. Represents the location of the top of the crop rectangle expressed, in unit of inches.

```javascript
getTopCropInch() : number;
```


### setTopCropInch(number) {#setTopCropInch-number-}

<b>@deprecated.</b> Please use the 'topCropInch' property instead. Represents the location of the top of the crop rectangle expressed, in unit of inches.

```javascript
setTopCropInch(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getBottomCropInch() {#getBottomCropInch--}

<b>@deprecated.</b> Please use the 'bottomCropInch' property instead. Represents the location of the bottom of the crop rectangle expressed, in unit of inches.

```javascript
getBottomCropInch() : number;
```


### setBottomCropInch(number) {#setBottomCropInch-number-}

<b>@deprecated.</b> Please use the 'bottomCropInch' property instead. Represents the location of the bottom of the crop rectangle expressed, in unit of inches.

```javascript
setBottomCropInch(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getLeftCropInch() {#getLeftCropInch--}

<b>@deprecated.</b> Please use the 'leftCropInch' property instead. Represents the location of the left of the crop rectangle expressed, in unit of inches.

```javascript
getLeftCropInch() : number;
```


### setLeftCropInch(number) {#setLeftCropInch-number-}

<b>@deprecated.</b> Please use the 'leftCropInch' property instead. Represents the location of the left of the crop rectangle expressed, in unit of inches.

```javascript
setLeftCropInch(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getRightCropInch() {#getRightCropInch--}

<b>@deprecated.</b> Please use the 'rightCropInch' property instead. Represents the location of the right of the crop rectangle expressed, in unit of inches.

```javascript
getRightCropInch() : number;
```


### setRightCropInch(number) {#setRightCropInch-number-}

<b>@deprecated.</b> Please use the 'rightCropInch' property instead. Represents the location of the right of the crop rectangle expressed, in unit of inches.

```javascript
setRightCropInch(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getTopCrop() {#getTopCrop--}

<b>@deprecated.</b> Please use the 'topCrop' property instead. Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height.

```javascript
getTopCrop() : number;
```


### setTopCrop(number) {#setTopCrop-number-}

<b>@deprecated.</b> Please use the 'topCrop' property instead. Represents the location of the top of the crop rectangle expressed, expressed as a ratio of the image's height.

```javascript
setTopCrop(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getBottomCrop() {#getBottomCrop--}

<b>@deprecated.</b> Please use the 'bottomCrop' property instead. Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height.

```javascript
getBottomCrop() : number;
```


### setBottomCrop(number) {#setBottomCrop-number-}

<b>@deprecated.</b> Please use the 'bottomCrop' property instead. Represents the location of the bottom of the crop rectangle expressed, expressed as a ratio of the image's height.

```javascript
setBottomCrop(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getLeftCrop() {#getLeftCrop--}

<b>@deprecated.</b> Please use the 'leftCrop' property instead. Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width.

```javascript
getLeftCrop() : number;
```


### setLeftCrop(number) {#setLeftCrop-number-}

<b>@deprecated.</b> Please use the 'leftCrop' property instead. Represents the location of the left of the crop rectangle expressed, expressed as a ratio of the image's width.

```javascript
setLeftCrop(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getRightCrop() {#getRightCrop--}

<b>@deprecated.</b> Please use the 'rightCrop' property instead. Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width.

```javascript
getRightCrop() : number;
```


### setRightCrop(number) {#setRightCrop-number-}

<b>@deprecated.</b> Please use the 'rightCrop' property instead. Represents the location of the right of the crop rectangle expressed, expressed as a ratio of the image's width.

```javascript
setRightCrop(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getTransparency() {#getTransparency--}

<b>@deprecated.</b> Please use the 'transparency' property instead. Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

```javascript
getTransparency() : number;
```


### setTransparency(number) {#setTransparency-number-}

<b>@deprecated.</b> Please use the 'transparency' property instead. Returns or sets the degree of transparency of the area as a value from 0.0 (opaque) through 1.0 (clear).

```javascript
setTransparency(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### getTransparentColor() {#getTransparentColor--}

<b>@deprecated.</b> Please use the 'transparentColor' property instead. Gets and sets the transparent color of the picture.

```javascript
getTransparentColor() : CellsColor;
```


**Returns**

[CellsColor](../cellscolor/)

### setTransparentColor(CellsColor) {#setTransparentColor-cellscolor-}

<b>@deprecated.</b> Please use the 'transparentColor' property instead. Gets and sets the transparent color of the picture.

```javascript
setTransparentColor(value: CellsColor) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | [CellsColor](../cellscolor/) | The value to set. |

### getContrast() {#getContrast--}

<b>@deprecated.</b> Please use the 'contrast' property instead. Represents the contrast modification for the picture.in unit of percentage.

```javascript
getContrast() : number;
```


**Remarks**

It is between -100% and 100%. It works same as Excel 2007 or above version.

### setContrast(number) {#setContrast-number-}

<b>@deprecated.</b> Please use the 'contrast' property instead. Represents the contrast modification for the picture.in unit of percentage.

```javascript
setContrast(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

**Remarks**

It is between -100% and 100%. It works same as Excel 2007 or above version.

### getBrightness() {#getBrightness--}

<b>@deprecated.</b> Please use the 'brightness' property instead. Represents the brightness modification for the picture in unit of percentage.

```javascript
getBrightness() : number;
```


**Remarks**

It is between -100% and 100%. It works same as Excel 2007 or above version.

### setBrightness(number) {#setBrightness-number-}

<b>@deprecated.</b> Please use the 'brightness' property instead. Represents the brightness modification for the picture in unit of percentage.

```javascript
setBrightness(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

**Remarks**

It is between -100% and 100%. It works same as Excel 2007 or above version.

### getGamma() {#getGamma--}

<b>@deprecated.</b> Please use the 'gamma' property instead. Represents gamma of the picture.

```javascript
getGamma() : number;
```


### setGamma(number) {#setGamma-number-}

<b>@deprecated.</b> Please use the 'gamma' property instead. Represents gamma of the picture.

```javascript
setGamma(value: number) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | number | The value to set. |

### isBiLevel() {#isBiLevel--}

<b>@deprecated.</b> Please use the 'isBiLevel' property instead. Indicates whether this picture should display in two-color black and white.

```javascript
isBiLevel() : boolean;
```


### setIsBiLevel(boolean) {#setIsBiLevel-boolean-}

<b>@deprecated.</b> Please use the 'isBiLevel' property instead. Indicates whether this picture should display in two-color black and white.

```javascript
setIsBiLevel(value: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |

### isGray() {#isGray--}

<b>@deprecated.</b> Please use the 'isGray' property instead. Indicates whether this picture should display in grayscale.

```javascript
isGray() : boolean;
```


### setIsGray(boolean) {#setIsGray-boolean-}

<b>@deprecated.</b> Please use the 'isGray' property instead. Indicates whether this picture should display in grayscale.

```javascript
setIsGray(value: boolean) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| value | boolean | The value to set. |

### isNull() {#isNull--}

Checks whether the implementation object is null.

```javascript
isNull() : boolean;
```


### getHashCode() {#getHashCode--}

Gets the hash code.

```javascript
getHashCode() : number;
```


### equals(Object) {#equals-object-}



```javascript
equals(obj: Object) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object |  |


