--- layout: apidoc title: "Overlays.PlainArrow - jsplumb API documentation" date: 2014-01-01 00:00:00 yuiGridsUrl: http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css yuiSeedUrl: http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js projectAssets: ../assets base: "../.." ---
Show:

Overlays.PlainArrow Class

Defined in: doc/api/overlays-api.js:31

This is just a specialized instance of Arrow in which jsPlumb hardcodes foldback to 1, meaning the tail of the Arrow is a flat edge

Constructor

Overlays.PlainArrow

(
  • params
)

Defined in doc/api/overlays-api.js:31

Parameters:

  • params Object

    Constructor parameters

    • [width=20] Integer optional

      Width of the tail of the arrow

    • [length=20] Integer optional

      Distance from the tail of the arrow to the head

    • [location=0.5] Float optional

      Where, either as a proportional value from 0 to 1 inclusive, or as an absolute value (negative values mean distance from target; positive values greater than 1 mean distance from source) the PlainArrow should appear on the Connector

    • [direction=1] Integer optional

      Which way to point. Allowed values are 1 (the default, meaning forwards) and -1, meaning backwards

    • [paintStyle] Object optional

      A style object in the form used for paintStyle values for Endpoints and Connectors.

Item Index