DsPdfJS API - v9.1.0
    Preparing search index...

    Class Format

    Represents a text format.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    backColor bold charWidthFactor doubleUnderline fillBrush font fontFamily fontFeatures fontSize foreColor glyphAdvanceFactor glyphAdvanceOffset glyphWidths hollow id italic language lineGap om paletteIndex recalcFontSizeForFallbackFonts sidewaysInVerticalText skipNormalization strictCanonicalDecomposition strikethrough strokePen subscript superscript textRunAsCluster transformToFullWidth transverseOffset treatHyphenMinusAsHyphen underline uprightInVerticalText useHorizontalMetricsForVerticalText useTypoMetrics useVerticalLineGapForSideways

    Methods

    free rebind

    Constructors

    Accessors

    • get backColor(): Color

      Gets the text background color.

      Returns Color

    • get bold(): boolean

      Gets a value indicating whether the font should be bolded.

      Returns boolean

    • get charWidthFactor(): number

      Gets the character width scale factor. Values are between 0.1 and 10.0.

      Returns number

    • get doubleUnderline(): boolean

      Gets a value indicating if the text is double underlined.

      Returns boolean

    • get fillBrush(): Brush | null

      Gets the brush to fill the glyphs.

      Returns Brush | null

    • get fontFamily(): string

      Gets the font family name.

      Returns string

    • get fontFeatures(): FontFeature[] | null

      Gets the array of assigned Microsoft OpenType typography properties.

      Returns FontFeature[] | null

    • get fontSize(): number

      Gets the logical font size, in graphic units.

      Returns number

    • get foreColor(): Color

      Gets the text foreground color.

      Returns Color

    • get glyphAdvanceFactor(): number

      Gets the scaling factor for the glyph advance value relative to font's Average Character Width. Values are from 0.5 up.

      Returns number

    • get glyphAdvanceOffset(): number

      Gets the absolute increment (delta) for the glyph advance value, in graphic units.

      Returns number

    • get glyphWidths(): GlyphWidths

      Gets the preferred glyph widths (generally used in CJKV fonts).

      Returns GlyphWidths

    • get hollow(): boolean

      Gets a value indicating if the glyphs are hollow (outlined), otherwise they are solid.

      Returns boolean

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get italic(): boolean

      Gets a value indicating whether the font should be italicized.

      Returns boolean

    • get language(): string

      Gets the Neutral Culture string, if assigned.

      Returns string

    • get lineGap(): number | null

      Gets the explicit line gap (if not null), in graphic units.

      Returns number | null

    • get paletteIndex(): number | null

      Gets the index of a palette used for drawing color fonts.

      Returns number | null

    • get recalcFontSizeForFallbackFonts(): boolean

      Gets a value indicating whether the size of a fallback font should be coerced to the size of original font.

      Returns boolean

    • get sidewaysInVerticalText(): boolean

      Gets a value indicating if all characters should appear as rotated 90 or -90 degrees in vertical text.

      Returns boolean

    • get skipNormalization(): boolean

      Gets a value indicating whether the canonical decomposition, reordering, and composition stages should be omitted.

      Returns boolean

    • get strictCanonicalDecomposition(): boolean

      Gets a value indicating whether to apply normalization to Singleton Decompositions and Post Composition Version precomposed characters.

      Returns boolean

    • get strikethrough(): boolean

      Gets a value indicating if the strikethrough style is applied to the text.

      Returns boolean

    • get strokePen(): Pen | null

      Gets the pen to draw glyph outlines.

      Returns Pen | null

    • get subscript(): boolean

      Gets a value indicating if the glyphs should be displayed as subscript.

      Returns boolean

    • get superscript(): boolean

      Gets a value indicating if the glyphs should be displayed as superscript.

      Returns boolean

    • get textRunAsCluster(): boolean

      Gets a value indicating whether the whole text run should be considered as a single Grapheme Cluster.

      Returns boolean

    • get transformToFullWidth(): boolean

      Gets a value indicating if ASCII characters should be transformed into fullwidth characters.

      Returns boolean

    • get transverseOffset(): number

      Gets the offset of the text in the orthogonal direction, in graphic units.

      Returns number

    • get treatHyphenMinusAsHyphen(): boolean

      Gets a value indicating whether the character 'HYPHEN-MINUS' (U+002D) is treated as the character 'HYPHEN' (U+2010) by the Unicode line breaking algorithm.

      Returns boolean

    • get underline(): boolean

      Gets a value indicating if the text is underlined.

      Returns boolean

    • get uprightInVerticalText(): boolean

      Gets a value indicating if the normally sideways characters should be drawn upright in vertical text.

      Returns boolean

    • get useHorizontalMetricsForVerticalText(): boolean

      Gets a value indicating if the horizontal ascending, descending, and line gap settings should be applied to vertical text.

      Returns boolean

    • get useTypoMetrics(): boolean

      Gets a value indicating whether the typographical font metrics should be applied instead of Windows-specific and Apple-specific font metrics.

      Returns boolean

    • get useVerticalLineGapForSideways(): boolean

      Gets a value indicating that for sideways text in vertical flow, line gap will be set according to Font.verticalLineGap. If false, line gap for lines containing sideways text is set according to Font.horizontalLineGap, which can lead to different gaps between columns that contain sideways text runs and those that do not.

      Returns boolean

    Methods

    • Detaches the object from the ObjectManager and deallocates its memory, if possible.

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods