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

  • API Docs for Version: 1.1.80

    • APIs

    Show:

    fabric.Object Class

    Defined in: _common\_js\fabric\fabric.require.js:10375
    Module: Classes

    Root object class from which all 2d shape classes inherit from

    Methods

    getAngle

    () Number

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

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

    Returns:

    Number:

    getClipTo

    () Function

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

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

    Returns:

    Function:

    getFill

    () String

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

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

    Returns:

    String:

    Fill value

    getFlipX

    () Boolean

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

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

    Returns:

    Boolean:

    flipX value

    getFlipY

    () Boolean

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

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

    Returns:

    Boolean:

    flipY value

    getLeft

    () Number

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

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

    Returns:

    Number:

    Left value (in pixels)

    getOpacity

    () Number

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

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

    Returns:

    Number:

    Opacity value (0-1)

    getOriginX

    () String

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

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

    Returns:

    String:

    originX value

    getOriginY

    () String

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

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

    Returns:

    String:

    originY value

    getScaleX

    () Number

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

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

    Returns:

    Number:

    scaleX value

    getScaleY

    () Number

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

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

    Returns:

    Number:

    scaleY value

    getShadow

    () Object

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

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

    Returns:

    Object:

    Shadow instance

    getStroke

    () String

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

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

    Returns:

    String:

    stroke value

    getStrokeWidth

    () Number

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

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

    Returns:

    Number:

    strokeWidth value

    getTop

    () Number

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

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

    Returns:

    Number:

    Top value (in pixels)

    getTransformMatrix

    () Array

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

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

    Returns:

    Array:

    transformMatrix

    getViewportTransform

    () Boolean

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

    Retrieves viewportTransform from Object's canvas if possible

    Returns:

    Boolean:

    flipY value // TODO

    getVisible

    () Boolean

    Defined in _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

    Defined in _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

    Defined in _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

    Defined in _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

    Defined in _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

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

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

    Parameters:

    Returns:

    fabric.Object:

    thisArg

    setLeft

    (
    • value
    )
    fabric.Object chainable

    Defined in _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

    setOpacity

    (
    • value
    )
    fabric.Object chainable

    Defined in _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

    Defined in _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

    Defined in _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

    Defined in _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

    Defined in _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

    Defined in _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

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

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

    Parameters:

    • value Number

      strokeWidth value

    Returns:

    fabric.Object:

    thisArg

    setTop

    (
    • value
    )
    fabric.Object chainable

    Defined in _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

    Defined in _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

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

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

    Parameters:

    Returns:

    fabric.Object:

    thisArg