## ShapeTextAlignment class

Represents the setting of shape's text alignment;

```javascript
class ShapeTextAlignment;
```


## Properties

| Property | Type | Description |
| --- | --- | --- |
| [isTextWrapped](#isTextWrapped--)| boolean | Gets or sets the text wrapped type of the shape which contains text. |
| [rotateTextWithShape](#rotateTextWithShape--)| boolean | Indicates whether rotating text with shape. |
| [textVerticalOverflow](#textVerticalOverflow--)| TextOverflowType | Gets and sets the text vertical overflow type of the text box. |
| [textHorizontalOverflow](#textHorizontalOverflow--)| TextOverflowType | Gets and sets the text horizontal overflow type of the text box. |
| [rotationAngle](#rotationAngle--)| number | Gets and sets the rotation of the shape. |
| [textVerticalType](#textVerticalType--)| TextVerticalType | Gets and sets the text direction. |
| [isLockedText](#isLockedText--)| boolean | Indicates whether the shape is locked when worksheet is protected. |
| [autoSize](#autoSize--)| boolean | Indicates if size of shape is adjusted automatically according to its content. |
| [textShapeType](#textShapeType--)| AutoShapeType | Gets and set the transform type of text. |
| [topMarginPt](#topMarginPt--)| number | Returns the top margin in unit of Points |
| [bottomMarginPt](#bottomMarginPt--)| number | Returns the bottom margin in unit of Points |
| [leftMarginPt](#leftMarginPt--)| number | Returns the left margin in unit of Points |
| [rightMarginPt](#rightMarginPt--)| number | Returns the right margin in unit of Points |
| [isAutoMargin](#isAutoMargin--)| boolean | Indicates whether the margin of the text frame is automatic. |
| [numberOfColumns](#numberOfColumns--)| number | Gets and sets the number of columns of text in the bounding rectangle. |

## Methods

| Method | Description |
| --- | --- |
| [isTextWrapped()](#isTextWrapped--)| <b>@deprecated.</b> Please use the 'isTextWrapped' property instead. Gets or sets the text wrapped type of the shape which contains text. |
| [setIsTextWrapped(boolean)](#setIsTextWrapped-boolean-)| <b>@deprecated.</b> Please use the 'isTextWrapped' property instead. Gets or sets the text wrapped type of the shape which contains text. |
| [getRotateTextWithShape()](#getRotateTextWithShape--)| <b>@deprecated.</b> Please use the 'rotateTextWithShape' property instead. Indicates whether rotating text with shape. |
| [setRotateTextWithShape(boolean)](#setRotateTextWithShape-boolean-)| <b>@deprecated.</b> Please use the 'rotateTextWithShape' property instead. Indicates whether rotating text with shape. |
| [getTextVerticalOverflow()](#getTextVerticalOverflow--)| <b>@deprecated.</b> Please use the 'textVerticalOverflow' property instead. Gets and sets the text vertical overflow type of the text box. |
| [setTextVerticalOverflow(TextOverflowType)](#setTextVerticalOverflow-textoverflowtype-)| <b>@deprecated.</b> Please use the 'textVerticalOverflow' property instead. Gets and sets the text vertical overflow type of the text box. |
| [getTextHorizontalOverflow()](#getTextHorizontalOverflow--)| <b>@deprecated.</b> Please use the 'textHorizontalOverflow' property instead. Gets and sets the text horizontal overflow type of the text box. |
| [setTextHorizontalOverflow(TextOverflowType)](#setTextHorizontalOverflow-textoverflowtype-)| <b>@deprecated.</b> Please use the 'textHorizontalOverflow' property instead. Gets and sets the text horizontal overflow type of the text box. |
| [getRotationAngle()](#getRotationAngle--)| <b>@deprecated.</b> Please use the 'rotationAngle' property instead. Gets and sets the rotation of the shape. |
| [setRotationAngle(number)](#setRotationAngle-number-)| <b>@deprecated.</b> Please use the 'rotationAngle' property instead. Gets and sets the rotation of the shape. |
| [getTextVerticalType()](#getTextVerticalType--)| <b>@deprecated.</b> Please use the 'textVerticalType' property instead. Gets and sets the text direction. |
| [setTextVerticalType(TextVerticalType)](#setTextVerticalType-textverticaltype-)| <b>@deprecated.</b> Please use the 'textVerticalType' property instead. Gets and sets the text direction. |
| [isLockedText()](#isLockedText--)| <b>@deprecated.</b> Please use the 'isLockedText' property instead. Indicates whether the shape is locked when worksheet is protected. |
| [setIsLockedText(boolean)](#setIsLockedText-boolean-)| <b>@deprecated.</b> Please use the 'isLockedText' property instead. Indicates whether the shape is locked when worksheet is protected. |
| [getAutoSize()](#getAutoSize--)| <b>@deprecated.</b> Please use the 'autoSize' property instead. Indicates if size of shape is adjusted automatically according to its content. |
| [setAutoSize(boolean)](#setAutoSize-boolean-)| <b>@deprecated.</b> Please use the 'autoSize' property instead. Indicates if size of shape is adjusted automatically according to its content. |
| [getTextShapeType()](#getTextShapeType--)| <b>@deprecated.</b> Please use the 'textShapeType' property instead. Gets and set the transform type of text. |
| [setTextShapeType(AutoShapeType)](#setTextShapeType-autoshapetype-)| <b>@deprecated.</b> Please use the 'textShapeType' property instead. Gets and set the transform type of text. |
| [getTopMarginPt()](#getTopMarginPt--)| <b>@deprecated.</b> Please use the 'topMarginPt' property instead. Returns the top margin in unit of Points |
| [setTopMarginPt(number)](#setTopMarginPt-number-)| <b>@deprecated.</b> Please use the 'topMarginPt' property instead. Returns the top margin in unit of Points |
| [getBottomMarginPt()](#getBottomMarginPt--)| <b>@deprecated.</b> Please use the 'bottomMarginPt' property instead. Returns the bottom margin in unit of Points |
| [setBottomMarginPt(number)](#setBottomMarginPt-number-)| <b>@deprecated.</b> Please use the 'bottomMarginPt' property instead. Returns the bottom margin in unit of Points |
| [getLeftMarginPt()](#getLeftMarginPt--)| <b>@deprecated.</b> Please use the 'leftMarginPt' property instead. Returns the left margin in unit of Points |
| [setLeftMarginPt(number)](#setLeftMarginPt-number-)| <b>@deprecated.</b> Please use the 'leftMarginPt' property instead. Returns the left margin in unit of Points |
| [getRightMarginPt()](#getRightMarginPt--)| <b>@deprecated.</b> Please use the 'rightMarginPt' property instead. Returns the right margin in unit of Points |
| [setRightMarginPt(number)](#setRightMarginPt-number-)| <b>@deprecated.</b> Please use the 'rightMarginPt' property instead. Returns the right margin in unit of Points |
| [isAutoMargin()](#isAutoMargin--)| <b>@deprecated.</b> Please use the 'isAutoMargin' property instead. Indicates whether the margin of the text frame is automatic. |
| [setIsAutoMargin(boolean)](#setIsAutoMargin-boolean-)| <b>@deprecated.</b> Please use the 'isAutoMargin' property instead. Indicates whether the margin of the text frame is automatic. |
| [getNumberOfColumns()](#getNumberOfColumns--)| <b>@deprecated.</b> Please use the 'numberOfColumns' property instead. Gets and sets the number of columns of text in the bounding rectangle. |
| [setNumberOfColumns(number)](#setNumberOfColumns-number-)| <b>@deprecated.</b> Please use the 'numberOfColumns' property instead. Gets and sets the number of columns of text in the bounding rectangle. |
| [isNull()](#isNull--)| Checks whether the implementation object is null. |
| [equals(Object)](#equals-object-)| Determines whether this instance has the same value as another specified [ShapeTextAlignment](../shapetextalignment/) object. |
| [getHashCode()](#getHashCode--)|  |


### isTextWrapped {#isTextWrapped--}

Gets or sets the text wrapped type of the shape which contains text.

```javascript
isTextWrapped : boolean;
```


### rotateTextWithShape {#rotateTextWithShape--}

Indicates whether rotating text with shape.

```javascript
rotateTextWithShape : boolean;
```


### textVerticalOverflow {#textVerticalOverflow--}

Gets and sets the text vertical overflow type of the text box.

```javascript
textVerticalOverflow : TextOverflowType;
```


### textHorizontalOverflow {#textHorizontalOverflow--}

Gets and sets the text horizontal overflow type of the text box.

```javascript
textHorizontalOverflow : TextOverflowType;
```


### rotationAngle {#rotationAngle--}

Gets and sets the rotation of the shape.

```javascript
rotationAngle : number;
```


### textVerticalType {#textVerticalType--}

Gets and sets the text direction.

```javascript
textVerticalType : TextVerticalType;
```


### isLockedText {#isLockedText--}

Indicates whether the shape is locked when worksheet is protected.

```javascript
isLockedText : boolean;
```


**Remarks**

Only works when worksheet is protected.

### autoSize {#autoSize--}

Indicates if size of shape is adjusted automatically according to its content.

```javascript
autoSize : boolean;
```


### textShapeType {#textShapeType--}

Gets and set the transform type of text.

```javascript
textShapeType : AutoShapeType;
```


### topMarginPt {#topMarginPt--}

Returns the top margin in unit of Points

```javascript
topMarginPt : number;
```


### bottomMarginPt {#bottomMarginPt--}

Returns the bottom margin in unit of Points

```javascript
bottomMarginPt : number;
```


### leftMarginPt {#leftMarginPt--}

Returns the left margin in unit of Points

```javascript
leftMarginPt : number;
```


### rightMarginPt {#rightMarginPt--}

Returns the right margin in unit of Points

```javascript
rightMarginPt : number;
```


### isAutoMargin {#isAutoMargin--}

Indicates whether the margin of the text frame is automatic.

```javascript
isAutoMargin : boolean;
```


### numberOfColumns {#numberOfColumns--}

Gets and sets the number of columns of text in the bounding rectangle.

```javascript
numberOfColumns : number;
```


### isTextWrapped() {#isTextWrapped--}

<b>@deprecated.</b> Please use the 'isTextWrapped' property instead. Gets or sets the text wrapped type of the shape which contains text.

```javascript
isTextWrapped() : boolean;
```


### setIsTextWrapped(boolean) {#setIsTextWrapped-boolean-}

<b>@deprecated.</b> Please use the 'isTextWrapped' property instead. Gets or sets the text wrapped type of the shape which contains text.

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

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

### getRotateTextWithShape() {#getRotateTextWithShape--}

<b>@deprecated.</b> Please use the 'rotateTextWithShape' property instead. Indicates whether rotating text with shape.

```javascript
getRotateTextWithShape() : boolean;
```


### setRotateTextWithShape(boolean) {#setRotateTextWithShape-boolean-}

<b>@deprecated.</b> Please use the 'rotateTextWithShape' property instead. Indicates whether rotating text with shape.

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

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

### getTextVerticalOverflow() {#getTextVerticalOverflow--}

<b>@deprecated.</b> Please use the 'textVerticalOverflow' property instead. Gets and sets the text vertical overflow type of the text box.

```javascript
getTextVerticalOverflow() : TextOverflowType;
```


**Returns**

[TextOverflowType](../textoverflowtype/)

### setTextVerticalOverflow(TextOverflowType) {#setTextVerticalOverflow-textoverflowtype-}

<b>@deprecated.</b> Please use the 'textVerticalOverflow' property instead. Gets and sets the text vertical overflow type of the text box.

```javascript
setTextVerticalOverflow(value: TextOverflowType) : void;
```

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

### getTextHorizontalOverflow() {#getTextHorizontalOverflow--}

<b>@deprecated.</b> Please use the 'textHorizontalOverflow' property instead. Gets and sets the text horizontal overflow type of the text box.

```javascript
getTextHorizontalOverflow() : TextOverflowType;
```


**Returns**

[TextOverflowType](../textoverflowtype/)

### setTextHorizontalOverflow(TextOverflowType) {#setTextHorizontalOverflow-textoverflowtype-}

<b>@deprecated.</b> Please use the 'textHorizontalOverflow' property instead. Gets and sets the text horizontal overflow type of the text box.

```javascript
setTextHorizontalOverflow(value: TextOverflowType) : void;
```

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

### getRotationAngle() {#getRotationAngle--}

<b>@deprecated.</b> Please use the 'rotationAngle' property instead. Gets and sets the rotation of the shape.

```javascript
getRotationAngle() : number;
```


### setRotationAngle(number) {#setRotationAngle-number-}

<b>@deprecated.</b> Please use the 'rotationAngle' property instead. Gets and sets the rotation of the shape.

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

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

### getTextVerticalType() {#getTextVerticalType--}

<b>@deprecated.</b> Please use the 'textVerticalType' property instead. Gets and sets the text direction.

```javascript
getTextVerticalType() : TextVerticalType;
```


**Returns**

[TextVerticalType](../textverticaltype/)

### setTextVerticalType(TextVerticalType) {#setTextVerticalType-textverticaltype-}

<b>@deprecated.</b> Please use the 'textVerticalType' property instead. Gets and sets the text direction.

```javascript
setTextVerticalType(value: TextVerticalType) : void;
```

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

### isLockedText() {#isLockedText--}

<b>@deprecated.</b> Please use the 'isLockedText' property instead. Indicates whether the shape is locked when worksheet is protected.

```javascript
isLockedText() : boolean;
```


**Remarks**

Only works when worksheet is protected.

### setIsLockedText(boolean) {#setIsLockedText-boolean-}

<b>@deprecated.</b> Please use the 'isLockedText' property instead. Indicates whether the shape is locked when worksheet is protected.

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

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

**Remarks**

Only works when worksheet is protected.

### getAutoSize() {#getAutoSize--}

<b>@deprecated.</b> Please use the 'autoSize' property instead. Indicates if size of shape is adjusted automatically according to its content.

```javascript
getAutoSize() : boolean;
```


### setAutoSize(boolean) {#setAutoSize-boolean-}

<b>@deprecated.</b> Please use the 'autoSize' property instead. Indicates if size of shape is adjusted automatically according to its content.

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

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

### getTextShapeType() {#getTextShapeType--}

<b>@deprecated.</b> Please use the 'textShapeType' property instead. Gets and set the transform type of text.

```javascript
getTextShapeType() : AutoShapeType;
```


**Returns**

[AutoShapeType](../autoshapetype/)

### setTextShapeType(AutoShapeType) {#setTextShapeType-autoshapetype-}

<b>@deprecated.</b> Please use the 'textShapeType' property instead. Gets and set the transform type of text.

```javascript
setTextShapeType(value: AutoShapeType) : void;
```

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

### getTopMarginPt() {#getTopMarginPt--}

<b>@deprecated.</b> Please use the 'topMarginPt' property instead. Returns the top margin in unit of Points

```javascript
getTopMarginPt() : number;
```


### setTopMarginPt(number) {#setTopMarginPt-number-}

<b>@deprecated.</b> Please use the 'topMarginPt' property instead. Returns the top margin in unit of Points

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

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

### getBottomMarginPt() {#getBottomMarginPt--}

<b>@deprecated.</b> Please use the 'bottomMarginPt' property instead. Returns the bottom margin in unit of Points

```javascript
getBottomMarginPt() : number;
```


### setBottomMarginPt(number) {#setBottomMarginPt-number-}

<b>@deprecated.</b> Please use the 'bottomMarginPt' property instead. Returns the bottom margin in unit of Points

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

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

### getLeftMarginPt() {#getLeftMarginPt--}

<b>@deprecated.</b> Please use the 'leftMarginPt' property instead. Returns the left margin in unit of Points

```javascript
getLeftMarginPt() : number;
```


### setLeftMarginPt(number) {#setLeftMarginPt-number-}

<b>@deprecated.</b> Please use the 'leftMarginPt' property instead. Returns the left margin in unit of Points

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

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

### getRightMarginPt() {#getRightMarginPt--}

<b>@deprecated.</b> Please use the 'rightMarginPt' property instead. Returns the right margin in unit of Points

```javascript
getRightMarginPt() : number;
```


### setRightMarginPt(number) {#setRightMarginPt-number-}

<b>@deprecated.</b> Please use the 'rightMarginPt' property instead. Returns the right margin in unit of Points

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

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

### isAutoMargin() {#isAutoMargin--}

<b>@deprecated.</b> Please use the 'isAutoMargin' property instead. Indicates whether the margin of the text frame is automatic.

```javascript
isAutoMargin() : boolean;
```


### setIsAutoMargin(boolean) {#setIsAutoMargin-boolean-}

<b>@deprecated.</b> Please use the 'isAutoMargin' property instead. Indicates whether the margin of the text frame is automatic.

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

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

### getNumberOfColumns() {#getNumberOfColumns--}

<b>@deprecated.</b> Please use the 'numberOfColumns' property instead. Gets and sets the number of columns of text in the bounding rectangle.

```javascript
getNumberOfColumns() : number;
```


### setNumberOfColumns(number) {#setNumberOfColumns-number-}

<b>@deprecated.</b> Please use the 'numberOfColumns' property instead. Gets and sets the number of columns of text in the bounding rectangle.

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

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

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

Checks whether the implementation object is null.

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


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

Determines whether this instance has the same value as another specified [ShapeTextAlignment](../shapetextalignment/) object.

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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| obj | Object | The [ShapeTextAlignment](../shapetextalignment/) object to compare with this instance. |

**Returns**

true if the value of the obj parameter is the same as the value of this instance; otherwise, false. If obj is null, this method returns false.

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



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