Interface Layouts

Layouts http://js.cytoscape.org/#layouts

The function of a layout is to set the positions on the nodes in the graph. Layouts are extensions of Cytoscape.js such that it is possible for anyone to write a layout without modifying the library itself. Several layouts are included with Cytoscape.js by default, and their options are described in the sections that follow with the default values specified. Note that you must set options.name to the name of the layout to specify which one you want to run. Each layout has its own algorithm for setting the position for each node. This algorithm influences the overall shape of the graph and the lengths of the edges. A layout’s algorithm can be customised by setting its options. Therefore, edge lengths can be controlled by setting the layout options appropriately. For force-directed (physics) layouts, there is generally an option to set a weight to each edge to affect the relative edge lengths. Edge length can also be affected by options like spacing factors, angles, and overlap avoidance. Setting edge length depends on the particular layout, and some layouts will allow for more precise edge lengths than others.

interface Layouts {
    addListener(events: string, handler: EventHandler): this;
    addListener(events: string, data: any, handler: EventHandler): this;
    bind(events: string, handler: EventHandler): this;
    bind(events: string, data: any, handler: EventHandler): this;
    listen(events: string, handler: EventHandler): this;
    listen(events: string, data: any, handler: EventHandler): this;
    off(events: string, handler?: EventHandler): this;
    on(events: string, handler: EventHandler): this;
    on(events: string, data: any, handler: EventHandler): this;
    one(events: string, handler: EventHandler): this;
    one(events: string, data: any, handler: EventHandler): this;
    pon(events: string): Promise<EventObject>;
    promiseOn(events: string): Promise<EventObject>;
    removeAllListeners(): this;
    removeListener(events: string, handler?: EventHandler): this;
    run(): this;
    start(): this;
    stop(): this;
    trigger(events: string, extraParams?: any[]): this;
    unbind(events: string, handler?: EventHandler): this;
    unlisten(events: string, handler?: EventHandler): this;
}

Hierarchy (view full)

Methods

addListener bind listen off on one pon promiseOn removeAllListeners removeListener run start stop trigger unbind unlisten

Methods

addListener

bind

listen

off

on

one

pon

promiseOn

removeAllListeners

removeListener

run

start

stop

trigger

unbind

unlisten

Settings

Member Visibility

On This Page

Methods