digitalsignage.com - open source docs digitalsignage.com - open source docs

  • API Docs for Version: 1.1.80

    • APIs

    Show:

    fabric.Image.filters.fabric.Text Class

    Extends fabric.Object
    Defined in: _common\_js\fabric\fabric.require.js:18880
    Module: Classes

    Text class

    Methods

    getAngle

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10546

    Retrieves object's {@link fabric.Object#angle|angle} (in degrees)

    Returns:

    Number:

    getClipTo

    () Function

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10395

    Retrieves object's {@link fabric.Object#clipTo|clipping function}

    Returns:

    Function:

    getFill

    () String

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10514

    Retrieves object's {@link fabric.Object#fill|fill}

    Returns:

    String:

    Fill value

    getFlipX

    () Boolean

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10626

    Retrieves object's {@link fabric.Object#flipX|flipX} value

    Returns:

    Boolean:

    flipX value

    getFlipY

    () Boolean

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10642

    Retrieves object's {@link fabric.Object#flipY|flipY} value

    Returns:

    Boolean:

    flipY value

    getFontFamily

    () String

    Defined in _common\_js\fabric\fabric.require.js:18944

    Retrieves object's fontFamily

    Returns:

    String:

    Font family

    getFontSize

    () String

    Defined in _common\_js\fabric\fabric.require.js:18912

    Retrieves object's fontSize

    Returns:

    String:

    Font size (in pixels)

    getFontStyle

    () String

    Defined in _common\_js\fabric\fabric.require.js:18992

    Retrieves object's fontStyle

    Returns:

    String:

    Font style

    getFontWeight

    () (String | Number)

    Defined in _common\_js\fabric\fabric.require.js:18928

    Retrieves object's fontWeight

    Returns:

    (String | Number):

    Font weight

    getLeft

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10578

    Retrieves object's {@link fabric.Object#left|left position}

    Returns:

    Number:

    Left value (in pixels)

    getLineHeight

    () Number

    Defined in _common\_js\fabric\fabric.require.js:19008

    Retrieves object's lineHeight

    Returns:

    Number:

    Line height

    getOpacity

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10530

    Retrieves object's {@link fabric.Object#opacity|opacity}

    Returns:

    Number:

    Opacity value (0-1)

    getOriginX

    () String

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10482

    Retrieves object's {@link fabric.Object#originX|originX}

    Returns:

    String:

    originX value

    getOriginY

    () String

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10498

    Retrieves object's {@link fabric.Object#originY|originY}

    Returns:

    String:

    originY value

    getScaleX

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10594

    Retrieves object's {@link fabric.Object#scaleX|scaleX} value

    Returns:

    Number:

    scaleX value

    getScaleY

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10610

    Retrieves object's {@link fabric.Object#scaleY|scaleY} value

    Returns:

    Number:

    scaleY value

    getShadow

    () Object

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10443

    Retrieves object's {@link fabric.Object#shadow|shadow}

    Returns:

    Object:

    Shadow instance

    getStroke

    () String

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10450

    Retrieves object's {@link fabric.Object#stroke|stroke}

    Returns:

    String:

    stroke value

    getStrokeWidth

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10466

    Retrieves object's {@link fabric.Object#strokeWidth|strokeWidth}

    Returns:

    Number:

    strokeWidth value

    getText

    () String

    Defined in _common\_js\fabric\fabric.require.js:18960

    Retrieves object's text

    Returns:

    String:

    text

    getTextAlign

    () String

    Defined in _common\_js\fabric\fabric.require.js:19024

    Retrieves object's textAlign

    Returns:

    String:

    Text alignment

    getTextBackgroundColor

    () String

    Defined in _common\_js\fabric\fabric.require.js:19040

    Retrieves object's textBackgroundColor

    Returns:

    String:

    Text background color

    getTextDecoration

    () String

    Defined in _common\_js\fabric\fabric.require.js:18976

    Retrieves object's textDecoration

    Returns:

    String:

    Text decoration

    getTop

    () Number

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10562

    Retrieves object's {@link fabric.Object#top|top position}

    Returns:

    Number:

    Top value (in pixels)

    getTransformMatrix

    () Array

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10411

    Retrieves object's {@link fabric.Object#transformMatrix|transformMatrix}

    Returns:

    Array:

    transformMatrix

    getViewportTransform

    () Boolean

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:11305

    Retrieves viewportTransform from Object's canvas if possible

    Returns:

    Boolean:

    flipY value // TODO

    getVisible

    () Boolean

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10427

    Retrieves object's {@link fabric.Object#visible|visible} state

    Returns:

    Boolean:

    True if visible

    setAngle

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10553

    Sets object's {@link fabric.Object#angle|angle}

    Parameters:

    • value Number

      Angle value (in degrees)

    Returns:

    fabric.Object:

    thisArg

    setClipTo

    (
    • clipTo
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10402

    Sets object's {@link fabric.Object#clipTo|clipping function}

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setFill

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10521

    Sets object's {@link fabric.Object#fill|fill}

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setFlipX

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10633

    Sets object's {@link fabric.Object#flipX|flipX} value

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setFlipY

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10649

    Sets object's {@link fabric.Object#flipY|flipY} value

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setFontFamily

    (
    • fontFamily
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:18951

    Sets object's fontFamily

    Parameters:

    • fontFamily String

      Font family

    Returns:

    fabric.Text:

    setFontSize

    (
    • fontSize
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:18919

    Sets object's fontSize

    Parameters:

    • fontSize Number

      Font size (in pixels)

    Returns:

    fabric.Text:

    setFontStyle

    (
    • fontStyle
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:18999

    Sets object's fontStyle

    Parameters:

    Returns:

    fabric.Text:

    setFontWeight

    (
    • fontWeight
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:18935

    Sets object's fontWeight

    Parameters:

    • fontWeight (Number | String)

      Font weight

    Returns:

    fabric.Text:

    setLeft

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10585

    Sets object's {@link fabric.Object#left|left position}

    Parameters:

    • value Number

      Left value (in pixels)

    Returns:

    fabric.Object:

    thisArg

    setLineHeight

    (
    • lineHeight
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:19015

    Sets object's lineHeight

    Parameters:

    • lineHeight Number

      Line height

    Returns:

    fabric.Text:

    setOpacity

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10537

    Sets object's {@link fabric.Object#opacity|opacity}

    Parameters:

    • value Number

      Opacity value (0-1)

    Returns:

    fabric.Object:

    thisArg

    setOriginX

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10489

    Sets object's {@link fabric.Object#originX|originX}

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setOriginY

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10505

    Sets object's {@link fabric.Object#originY|originY}

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setScaleX

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10601

    Sets object's {@link fabric.Object#scaleX|scaleX} value

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setScaleY

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10617

    Sets object's {@link fabric.Object#scaleY|scaleY} value

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setStroke

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10457

    Sets object's {@link fabric.Object#stroke|stroke}

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setStrokeWidth

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10473

    Sets object's {@link fabric.Object#strokeWidth|strokeWidth}

    Parameters:

    • value Number

      strokeWidth value

    Returns:

    fabric.Object:

    thisArg

    setText

    (
    • text
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:18967

    Sets object's text

    Parameters:

    Returns:

    fabric.Text:

    setTextAlign

    (
    • textAlign
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:19031

    Sets object's textAlign

    Parameters:

    • textAlign String

      Text alignment

    Returns:

    fabric.Text:

    setTextBackgroundColor

    (
    • textBackgroundColor
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:19047

    Sets object's textBackgroundColor

    Parameters:

    • textBackgroundColor String

      Text background color

    Returns:

    fabric.Text:

    setTextDecoration

    (
    • textDecoration
    )
    fabric.Text chainable

    Defined in _common\_js\fabric\fabric.require.js:18983

    Sets object's textDecoration

    Parameters:

    • textDecoration String

      Text decoration

    Returns:

    fabric.Text:

    setTop

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10569

    Sets object's {@link fabric.Object#top|top position}

    Parameters:

    • value Number

      Top value (in pixels)

    Returns:

    fabric.Object:

    thisArg

    setTransformMatrix

    (
    • transformMatrix
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10418

    Sets object's {@link fabric.Object#transformMatrix|transformMatrix}

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setVisible

    (
    • value
    )
    fabric.Object chainable

    Inherited from fabric.Object: _common\_js\fabric\fabric.require.js:10434

    Sets object's {@link fabric.Object#visible|visible} state

    Parameters:

    Returns:

    fabric.Object:

    thisArg