Show:

Overlays.Arrow Class

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

Draws an arrow, using four points: the head and two tail points, and a foldback point, which permits the tail of the arrow to be indented.

Constructor

Overlays.Arrow

(
  • params
)

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

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 Arrow 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

    • [foldback=0.623] Float optional

      How far along the axis of the arrow the tail points foldback in to.

    • [paintStyle] Object optional

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

Item Index