Function run

  • run(
        cy: Core,
        layoutConfig: LayoutOptions,
        subs?: string[],
        separateColours?: boolean,
        save?: boolean,
    ): Promise<boolean>

  • Layouts all visible nodes in a graph. Saves to cache but doesn't load from it, use runCached for that.

    Parameters

    • cy: Core

      the Cytoscape.js graph to run the layout on

    • layoutConfig: LayoutOptions

      the layout configuration, which includes the layout name and options

    • Optionalsubs: string[]

      Set of subontologies. If the subs are not given the layout still works but it is not saved.

    • separateColours: boolean = false

      Whether to separate the graph based on its colours.

    • save: boolean = false

      Whether to save the layout on local storage.

    Returns Promise<boolean>

    whether the layout could successfully be applied. Does not indicate success of saving to cache.

    Example

    run(cy,{"name":"grid"},new Set(["meta","ciox"]))

Settings

Member Visibility