Class TextItem

The Class that groups all Type related properties of a Text Layer in Photoshop.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/

Example

const app = require('photoshop').app;
const textItem = app.activeDocument.activeLayers[0].textItem;

Some properties and methods are available directly in the TextItem instance itself:

Example

textItem.contents; // "Lorem Ipsum"
textItem.contents = "Hello World";
textItem.isPointText; // true
await textItem.convertToParagraphText();

Most properties and methods are grouped for convenience in the characterStyle and paragraphStyle properties of TextItem.

textItem.characterStyle.size; // 12
textItem.characterStyle.size = 24;
textItem.paragraphStyle.hyphenation; // true

Finally, the warpStyle object contains all the properties related to the Warp effect applied to the text layer.

textItem.warpStyle.style; // "arcLower"

Please note that for some properties that are expressed in pixels, the valid range of values might depend on the document's resolution. When this is the case, you'll find that in the documentation "for a 72ppi document" is specified.

An example is the font size:

// Range: 0.01..1296—for a 72ppi document
textItem.characterStyle.size = 1000;

If you want to find the range for documents with a different resolution, please use the following conversion formula:

newVal = (documentResolution / 72) * referenceVal;

// I.e., for a 300ppi document the maximum font size will be:
// (300 / 72) * 1296 = 5400px

Upon setting a value, validation will be performed internally. An invalid value will result in a Range Error.

Min Version

24.1

Index

Constructors

constructor

new TextItem(): TextItem
Returns TextItem

Properties

characterStyle

characterStyle: CharacterStyle

The object that stores properties related to the Character panel in the Photoshop UI.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#characterstyle

Min Version

24.1

paragraphStyle

paragraphStyle: ParagraphStyle

The object that stores properties related to the Paragraph panel in the Photoshop UI.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#paragraphstyle

Min Version

24.1

warpStyle

warpStyle: TextWarpStyle

The object that stores properties related to the Warp Text dialog.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#warpstyle

Min Version

24.1

Accessors

get contents(): string
The actual text of the Layer.

Returns string
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#contents

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:90
set contents(text: string): void
Parameters
- text: string
Returns void
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:91

isParagraphText

get isParagraphText(): boolean
True if the Text Layer is a "Paragraph Text": text that uses boundaries to control the flow of characters, either horizontally or vertically.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#isparagraphtext

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:131

isPointText

get isPointText(): boolean
True if the Text Layer is a "Point Text": a horizontal or vertical line of text that begins where the user clicks in the image.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#ispointtext

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:123

orientation

get orientation(): Orientation
The text orientation.

Returns Orientation
Default
```
HORIZONTAL
```
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#orientation

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:114
set orientation(orientation: Orientation): void
Parameters
- orientation: Orientation
Returns void
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:115

parent

get parent(): Layer
The parent Layer

Returns Layer
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#parent

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:76

textClickPoint

get textClickPoint(): { x: number; y: number }
The text insertion point in the document, as an {x, y} object where the coordinates are expressed in pixels.

Returns { x: number; y: number }
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#textclickpoint

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:99
set textClickPoint(point: { x: number; y: number }): void
Parameters
- point: { x: number; y: number }
Returns void
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:103

typename

get typename(): "TextItem"
The typename

Returns "TextItem"
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#typename

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:83

Methods

convertToParagraphText

convertToParagraphText(): Promise<TextItem>
Convert a Text Layer from Point Text to Paragraph Text

Returns Promise<TextItem>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#converttoparagraphtext
Example
```
const textLayer = app.activeDocument.activeLayers[0];
if (textLayer.textItem.isPointText) {
  await textLayer.textItem.convertToParagraphText();
}
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:147

convertToPointText

convertToPointText(): Promise<TextItem>
Convert a Text Layer from Paragraph Text to Point Text

Returns Promise<TextItem>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#converttopointtext
Example
```
const textLayer = app.activeDocument.activeLayers[0];
if (textLayer.textItem.isParagraphText) {
  await textLayer.textItem.convertToPointText();
}
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:163

convertToShape

convertToShape(): Promise<void>
Convert the Text Layer into a Shape Layer

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#converttoshape
Example
```
const textLayer = app.activeDocument.activeLayers[0];
await textLayer.textItem.convertToShape();
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:177

createWorkPath

createWorkPath(): Promise<void>
Create a Work Path from the Text Layer

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/textitem/#createworkpath
Example
```
const textLayer = app.activeDocument.activeLayers[0];
await textLayer.textItem.createWorkPath();
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/TextItem.d.ts:191

Class TextItem

See

Example

Example

Min Version

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TextItem

Properties

characterStyle

See

Min Version

paragraphStyle

See

Min Version

warpStyle

See

Min Version

Accessors

contents

Returns string

See

Min Version

Parameters

Returns void

isParagraphText

Returns boolean

See

Min Version

isPointText

Returns boolean

See

Min Version

orientation

Returns Orientation

Default

See

Min Version

Parameters

Returns void

parent

Returns Layer

See

Min Version

textClickPoint

Returns { x: number; y: number }

See

Min Version

Parameters

Returns void

typename

Returns "TextItem"

See

Min Version

Methods

convertToParagraphText

Returns Promise<TextItem>

See

Example

Min Version

convertToPointText

Returns Promise<TextItem>

See

Example

Min Version

convertToShape

Returns Promise<void>

See

Example

Min Version

createWorkPath

Returns Promise<void>

See

Example

Min Version