Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CIMTextSymbol

Represents a text symbol which is used to draw text graphics, bleeds, and annotation. Text symbols do not contain any symbol layers but can have callouts.

Read more...

Hierarchy

Index

Properties

Optional angle

angle: number

The amount of rotation applied to the text symbol, measured in degrees, around the geometry.

Optional angleX

angleX: number

The amount of rotation of the text symbol around the X axis, measured in degrees, around the geometry. This type of rotation is also referred to as tilt. It is applied in 3D.

Optional angleY

angleY: number

The amount of rotation of the text symbol around the Y axis, measured in degrees, around the geometry. This type of rotation is also referred to as roll. It is applied in 3D.

Optional billboardMode3D

billboardMode3D: "None" | "SignPost" | "FaceNearPlane"

The billboard mode of the text symbol.

Optional blockProgression

blockProgression: "TTB" | "RTL" | "BTT"

The direction in which multi-line text is stacked.

Optional callout

The callout or background of the text with optional leader lines.

Optional compatibilityMode

compatibilityMode: boolean

A value indicating whether to draw the text in a fashion compatible with ArcMap.

Optional countryISO

countryISO: string

The ISO code for the base country of the text.

Optional depth3D

depth3D: number

The depth of the glyph when drawn in 3D. This is an extrusion of the characters of the text in the Z axis.

Optional drawGlyphsAsGeometry

drawGlyphsAsGeometry: boolean

A value indicating whether fonts that are drawn as rasters at some scales to draw as vectors instead.

Optional drawSoftHyphen

drawSoftHyphen: boolean

A value indicating whether soft hyphens should be drawn. Soft hyphens are invisible markers that indicate where a hyphenated break is allowed within the text. They are only drawn if there is word wrapping at the end of a line.

Optional extrapolateBaselines

extrapolateBaselines: boolean

A value indicating whether the baseline of the text geometry should be expanded in the same manner as the existing geometry if the text extends beyond the baseline.

Optional flipAngle

flipAngle: number

The angle (in degrees from vertical) at which point rotated text is flipped (mirrored) in place.

Optional fontEffects

fontEffects: "Normal" | "Superscript" | "Subscript"

Whether the text is drawn as subscript or superscript.

Optional fontEncoding

fontEncoding: "MSSymbol" | "Unicode"

The font encoding.

Optional fontFamilyName

fontFamilyName: string

The font family name of the font. e.g. Comic Sans.

Optional fontStyleName

fontStyleName: string

The style name for the font family. e.g. Regular, Bold, or Italic.

Optional fontType

fontType: "Unspecified" | "TrueType" | "PSOpenType" | "TTOpenType" | "Type1"

The type of font that the font family/style name reference.

Optional glyphRotation

glyphRotation: number

An additional rotation that is applied to the individual glyphs contained in the text. This is applied to the individual glyphs whereas Angle, AngleX and AngleY are affect how the entire text string is oriented.

Optional haloSize

haloSize: number

The size of the halo that extends beyond the symbol shape.

Optional haloSymbol

haloSymbol: CIMPolygonSymbol

The polygon symbol that is used to draw the halo for a text symbol.

Optional height

height: number

The size of the text in points.

Optional hinting

hinting: "Default" | "None" | "Force"

If hinting from the font is used for text rendering. Hinting is information included with most fonts to effectively fit the vector glyphs of the font into the raster grid onto which they are displayed.

Optional horizontalAlignment

horizontalAlignment: "Left" | "Right" | "Center" | "Justify"

The alignment type used to align the text to the geometry horizontally. Affects which side of a point geometry the point text is drawn or which end of a line it is drawn close to. Commonly used to define how stacked text appears.

Optional indentAfter

indentAfter: number

How many points to indent the text back from the end of the baseline.

Optional indentBefore

indentBefore: number

How many points to indent the text from the beginning of the baseline.

Optional indentFirstLine

indentFirstLine: number

How many points to indent the text from the beginning of the baseline for the first line only.

Optional kerning

kerning: boolean

A value indicating whether the text is drawn with metric kerning, which adjusts the spacing between individual letter forms.

Optional languageISO

languageISO: string

Whether the ISO code for the base language of the text.

Optional letterSpacing

letterSpacing: number

The additional spacing that is added to each glyph beyond what is defined by its character box in the font. Value indicates the percentage of a glyph's width. Also known as tracking.

Optional letterWidth

letterWidth: number

The width that is added to each glyph beyond what is defined by its character box in its font. This is a percentage of the original glyph.

Optional ligatures

ligatures: boolean

A value indicating whether text is to be drawn with ligatures, which occur when two or more letters or portions of letters are joined to form a single glyph.

Optional lineGap

lineGap: number

The spacing between lines of text. This is also known as leading or line spacing.

Optional lineGapType

lineGapType: "ExtraLeading" | "Multiple" | "Exact"

The type of line gap that is applied.

Optional offsetX

offsetX: number

The X offset.

Optional offsetY

offsetY: number

The Y offset.

Optional offsetZ

offsetZ: number

The Z offset.

Optional overprint

overprint: boolean

A value indicating whether or not the symbol should overprint in press printing.

Optional shadowColor

shadowColor: number[]

The color of the shadow that is defined for the text symbol. The shadow is drawn as an offset copy of the text.

Optional shadowOffsetX

shadowOffsetX: number

The shadow offset from the text symbol in the horizontal direction. If X and Y are zero, no shadow is drawn.

Optional shadowOffsetY

shadowOffsetY: number

The shadow offset from the text symbol in the vertical direction. If X and Y are zero, no shadow is drawn.

Optional smallCaps

smallCaps: boolean

A value indicating whether the text should be drawn as Small Capitals, where lower case text is converted to small caps and upper case text is left as upper case.

Optional strikethrough

strikethrough: boolean

A value indicating whether to draw the text with a strike through it.

Optional symbol

The polygon symbol that is used to draw the glyphs of the text.

Optional symbol3DProperties

symbol3DProperties: CIM3DSymbolProperties

The collection of properties that are applied to the text symbol only in a 3D context.

Optional textCase

textCase: "Normal" | "LowerCase" | "Allcaps"

The letter case used to draw the text.

Optional textDirection

textDirection: "RTL" | "LTR"

The base text direction to draw the text.

type

type: "CIMTextSymbol"

Optional underline

underline: boolean

A value indicating whether to draw the text with an underline.

Optional verticalAlignment

verticalAlignment: "Center" | "Top" | "Baseline" | "Bottom"

The vertical alignment of the text.

Optional verticalGlyphOrientation

verticalGlyphOrientation: "Right" | "Upright"

The orientation for the non-vertical text in a vertical layout. For example, an English fragment in a Japanese text.

Optional wordSpacing

wordSpacing: number

The additional spacing that is added to between the words of the text string. 100% indicates that regular spacing is used.

Generated using TypeDoc