Interface JsPlumbDefaults<E>

JsPlumb UI default keys.

interface JsPlumbDefaults<E> {
    astarGridCellSize?: number;
    astarVertexBorder?: number;
    astarVertexBuffer?: number;
    edgesAvoidVertices?: boolean;
    endpoint?: EndpointSpec;
}

Type Parameters

  • E

Hierarchy (view full)

Properties

astarGridCellSize?: number

Size of each cell in the grid that the AStar routine uses to calculate paths that avoid vertices. This defaults to 10 pixels and is not something you'll really need to change. If you do change it, keep in mind that a) a smaller grid size increases the runtime of the routine, and b) a large grid size will render the UI unusable.

astarVertexBorder?: number

Number of cells to pad each vertex with that act as its border: edges will be routed around the border wherever possible. Defaults to 2

astarVertexBuffer?: number

Number of cells to pad each vertex with that act as its buffer: edges will be routed around the buffer wherever possible. Defaults to 2 - but note this value is added the vertex border, whose default is 2, so the computed default is 4 grid cells.

edgesAvoidVertices?: boolean

If true, edges will avoid vertices. This only works if you are using the Straight connector; the setting will be ignored otherwise. This option is only ever set internally.

endpoint?: EndpointSpec

Default Endpoint to use.

Version :