Class CharacterStyle

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

Min Version

24.1

Constructors

constructor

new CharacterStyle(): CharacterStyle
Returns CharacterStyle

Accessors

alternateLigatures

get alternateLigatures(): boolean
Discretionary ligatures.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:148
set alternateLigatures(alternateLigatures: boolean): void
Parameters
- alternateLigatures: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:149

antiAliasMethod

get antiAliasMethod(): AntiAlias
The text anti-aliasing

Returns AntiAlias
Default
```
SHARP
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:246
set antiAliasMethod(antiAliasMethod: AntiAlias): void
Parameters
- antiAliasMethod: AntiAlias
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:247

autoKerning

get autoKerning(): AutoKernType
The auto kerning option to use.

Returns AutoKernType
Default
```
METRICS
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:106
set autoKerning(autoKerning: AutoKernType): void
Parameters
- autoKerning: AutoKernType
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:107

baseline

get baseline(): Baseline
The text baseline.

Returns Baseline
Default
```
NORMAL
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:120
set baseline(baseline: Baseline): void
Parameters
- baseline: Baseline
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:121

baselineShift

get baselineShift(): number
The value in pixels to use in the baseline offset of text for a 72ppi document.

Returns number
Range
-1296..1296

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:85
set baselineShift(baselineShift: number): void
Parameters
- baselineShift: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:86

capitalization

get capitalization(): TextCase
The text case.

Returns TextCase
Default
```
NORMAL
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:113
set capitalization(capitalization: TextCase): void
Parameters
- capitalization: TextCase
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:114

characterAlignment

get characterAlignment(): CharacterAlignment
Character alignment. When a line of text contains different sizes of characters, you can specify how to align text to the largest characters in the line.

Returns CharacterAlignment
Default
```
ROMAN
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:198
set characterAlignment(characterAlignment: CharacterAlignment): void
Parameters
- characterAlignment: CharacterAlignment
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:199

color

get color(): SolidColor
The text color as a SolidColor instance.

Returns SolidColor
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:211
set color(color: SolidColor): void
Parameters
- color: SolidColor
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:212

fauxBold

get fauxBold(): boolean
True to use Faux Bold. Setting this to true is equivalent to selecting text and clicking Faux Bold in the Character panel.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:45
set fauxBold(fauxBold: boolean): void
Parameters
- fauxBold: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:46

fauxItalic

get fauxItalic(): boolean
True to use Faux Italic. Setting this to true is equivalent to selecting text and clicking Faux Italic in the Character panel.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:54
set fauxItalic(fauxItalic: boolean): void
Parameters
- fauxItalic: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:55

font

get font(): string
The text face of the character, using the PostScript name of the font. See TextFont and use the postScriptName property.

Returns string
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:13
set font(font: string): void
Parameters
- font: string
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:14

fractionalWidths

get fractionalWidths(): boolean
Use fractional widths for the text.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:239
set fractionalWidths(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:240

fractions

get fractions(): boolean
Fractions.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:155
set fractions(fractions: boolean): void
Parameters
- fractions: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:156

horizontalDiacriticPosition

get horizontalDiacriticPosition(): number
Adjust the horizontal diacritic position for Middle Eastern languages.

Returns number
Range
-1000..1000

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:92
set horizontalDiacriticPosition(horizontalDiacriticPosition: number): void
Parameters
- horizontalDiacriticPosition: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:93

horizontalScale

get horizontalScale(): number
Character scaling (horizontal) in proportion to verticalScale, as a percentage value.

Returns number
Range
0..1000

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:28
set horizontalScale(horizontalScale: number): void
Parameters
- horizontalScale: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:29

kashidas

get kashidas(): boolean
Toggles kashidas in Middle Eastern languages.

Returns boolean
Default
```
true
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:218
set kashidas(kashidas: boolean): void
Parameters
- kashidas: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:219

language

get language(): Language
Language used as a basis for hyphenation rules and spelling.

Returns Language
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:189
set language(language: Language): void
Parameters
- language: Language
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:190

leading

get leading(): number
The leading amount in pixels for a 72ppi document.

Returns number
Default
```
null
```
Range
0..4999.99

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:68
set leading(leading: number): void
Parameters
- leading: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:69

ligatures

get ligatures(): boolean
Standard ligatures (default: true).

Returns boolean
Default
```
true
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:141
set ligatures(ligatures: boolean): void
Parameters
- ligatures: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:142

middleEasternDigitsType

get middleEasternDigitsType(): MiddleEasternDigitsType
The text digits type to use (Middle Eastern features)

Returns MiddleEasternDigitsType
Default
```
LTRARABIC
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:232
set middleEasternDigitsType(
middleEasternDigitsType: MiddleEasternDigitsType,
): void
Parameters
- middleEasternDigitsType: MiddleEasternDigitsType
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:233

middleEasternTextDirection

get middleEasternTextDirection(): MiddleEasternTextDirection
The text direction (Middle Eastern features)

Returns MiddleEasternTextDirection
Default
```
DEFAULT
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:225
set middleEasternTextDirection(
middleEasternTextDirection: MiddleEasternTextDirection,
): void
Parameters
- middleEasternTextDirection: MiddleEasternTextDirection
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:226

noBreak

get noBreak(): boolean
True to disallow line breaks in this text.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:205
set noBreak(noBreak: boolean): void
Parameters
- noBreak: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:206

ordinals

get ordinals(): boolean
Ordinals.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:162
set ordinals(ordinals: boolean): void
Parameters
- ordinals: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:163

size

get size(): number
The font size in pixels for a 72ppi document.

Returns number
Range
0.01..1296

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:20
set size(size: number): void
Parameters
- size: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:21

strikeThrough

get strikeThrough(): StrikeThrough
Whether the text is strikethrough or not.

Returns StrikeThrough
Default
```
STRIKEOFF
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:127
set strikeThrough(strikeThrough: StrikeThrough): void
Parameters
- strikeThrough: StrikeThrough
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:128

stylisticAlternates

get stylisticAlternates(): boolean
Stylistic Alternates

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:183
set stylisticAlternates(stylisticAlternates: boolean): void
Parameters
- stylisticAlternates: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:184

swash

get swash(): boolean
Swash.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:169
set swash(swash: boolean): void
Parameters
- swash: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:170

titlingAlternates

get titlingAlternates(): boolean
Titling alternates.

Returns boolean
Default
```
false
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:176
set titlingAlternates(titlingAlternates: boolean): void
Parameters
- titlingAlternates: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:177

tracking

get tracking(): number
The amount of uniform spacing between multiple characters. Tracking units are 1/1000 of an em space. The width of an em space is relative to the current type size. In a 1-point font, 1 em equals 1 point; in a 10-point font, 1 em equals 10 points. So for example, 100 tracking units in a 10-point font are equivalent to 1 point

Returns number
Range
-1000..1000

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:78
set tracking(tracking: number): void
Parameters
- tracking: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:79

underline

get underline(): Underline
The underline style to use.

Returns Underline
Default
```
NONE
```
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:134
set underline(underline: Underline): void
Parameters
- underline: Underline
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:135

useAutoLeading

get useAutoLeading(): boolean
True to use a font's built-in leading information.

Returns boolean
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:60
set useAutoLeading(useAutoLeading: boolean): void
Parameters
- useAutoLeading: boolean
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:61

verticalDiacriticPosition

get verticalDiacriticPosition(): number
Adjust the vertical diacritic position for Middle Eastern languages.

Returns number
Range
-1000..1000

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:99
set verticalDiacriticPosition(verticalDiacriticPosition: number): void
Parameters
- verticalDiacriticPosition: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:100

verticalScale

get verticalScale(): number
Character scaling (vertical) in proportion to horizontalScale, as a percentage value.

Returns number
Range
0..1000

Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:36
set verticalScale(verticalScale: number): void
Parameters
- verticalScale: number
Returns void
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:37

Methods

reset

reset(): Promise<void>
Resets the text styles of the Character panel to their default values.

Returns Promise<void>
Async
Min Version
24.1
- Defined in packages/types-photoshop/src/internal/dom/text/CharacterStyle.d.ts:253

Class CharacterStyle

Min Version

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns CharacterStyle

Accessors

alternateLigatures

Returns boolean

Default

Min Version

Parameters

Returns void

antiAliasMethod

Returns AntiAlias

Default

Min Version

Parameters

Returns void

autoKerning

Returns AutoKernType

Default

Min Version

Parameters

Returns void

baseline

Returns Baseline

Default

Min Version

Parameters

Returns void

baselineShift

Returns number

Range

Min Version

Parameters

Returns void

capitalization

Returns TextCase

Default

Min Version

Parameters

Returns void

characterAlignment

Returns CharacterAlignment

Default

Min Version

Parameters

Returns void

color

Returns SolidColor

Min Version

Parameters

Returns void

fauxBold

Returns boolean

Default

Min Version

Parameters

Returns void

fauxItalic

Returns boolean

Default

Min Version

Parameters

Returns void

font

Returns string

Min Version

Parameters

Returns void

fractionalWidths

Returns boolean

Default

Min Version

Parameters

Returns void