Interface CoreGraphManipulation

These are the principle functions used to interact with the graph model.

http://js.cytoscape.org/#core/graph-manipulation

interface CoreGraphManipulation {
    $(selector: string): CollectionReturnValue;
    $id(id: string): CollectionReturnValue;
    add(eles:
        | ElementDefinition
        | ElementsDefinition
        | ElementDefinition[]
        | CollectionArgument): CollectionReturnValue;
    batch(callback: (() => void)): void;
    collection(eles?: string | CollectionArgument[]): CollectionReturnValue;
    destroy(): void;
    destroyed(): boolean;
    edges(selector?: string): cytoscape.EdgeCollection;
    elements(selector?: string): CollectionReturnValue;
    endBatch(): void;
    filter(selector: string | ((ele: Singular<SingularElementReturnValue, SingularElementArgument>, i: number, eles: CollectionArgument) => boolean)): CollectionReturnValue;
    getElementById(id: string): CollectionReturnValue;
    hasElementWithId(id: string): boolean;
    mount(element: Element): void;
    nodes(selector?: string): cytoscape.NodeCollection;
    remove(eles: string | CollectionArgument): CollectionReturnValue;
    startBatch(): void;
    unmount(): void;
}

Hierarchy (view full)

CoreGraphManipulation
- cytoscape.Core

Index

Methods

$ $id add batch collection destroy destroyed edges elements endBatch filter getElementById hasElementWithId mount nodes remove startBatch unmount

Methods

batch

batch(callback): void
Allow for manipulation of elements without triggering multiple style calculations or multiple redraws. http://js.cytoscape.org/#cy.batch A callback within which you can make batch updates to elements.
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:483

collection

collection(eles?): CollectionReturnValue
Get a collection from elements in the graph matching the specified selector or from an array of elements. If no parameter specified, an empty collection will be returned
Parameters
- Optionaleles: string | CollectionArgument[]
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:431

destroy

destroy(): void
A convenience function to explicitly destroy the Core. http://js.cytoscape.org/#cy.destroy

Returns void
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:524

destroyed

destroyed(): boolean
Get whether the instance of Cytoscape.js has been destroyed or not. https://js.cytoscape.org/#cy.destroyed

Returns boolean
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:530

edges

edges(selector?): cytoscape.EdgeCollection
Get edges in the graph matching the specified selector.
Parameters
- Optionalselector: string
Returns cytoscape.EdgeCollection
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:470

elements

elements(selector?): CollectionReturnValue
Get elements in the graph matching the specified selector. http://js.cytoscape.org/#cy.$
Parameters
- Optionalselector: string
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:460

endBatch

endBatch(): void
Allow for manipulation of elements without triggering multiple style calculations or multiple redraws. http://js.cytoscape.org/#cy.batch

Ends batching manually (useful for asynchronous cases).

Returns void
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:497

filter

filter(selector): CollectionReturnValue
Get elements in the graph matching the specified selector or filter function.
Parameters
- selector: string | ((ele: Singular<SingularElementReturnValue, SingularElementArgument>, i: number, eles: CollectionArgument) => boolean)
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:474

getElementById

getElementById(id): CollectionReturnValue
Get an element from its ID in a very performant way. http://js.cytoscape.org/#cy.getElementById
Parameters
- id: string
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:442

hasElementWithId

hasElementWithId(id): boolean
check whether the specified id is in the collection
Parameters
- id: string
Returns boolean
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:436

mount

mount(element): void
Attaches the instance to the specified container for visualisation. http://js.cytoscape.org/#cy.mount

If the core instance is headless prior to calling cy.mount(), then the instance will no longer be headless and the visualisation will be shown in the specified container. If the core instance is non-headless prior to calling cy.mount(), then the visualisation is swapped from the prior container to the specified container.
Parameters
- element: Element
Returns void
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:509

nodes

nodes(selector?): cytoscape.NodeCollection
Get nodes in the graph matching the specified selector.
Parameters
- Optionalselector: string
Returns cytoscape.NodeCollection
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:465

remove

remove(eles): CollectionReturnValue
Remove elements in collecion or match the selector from the graph and return them.
Parameters
- eles: string | CollectionArgument
Returns CollectionReturnValue
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:425

startBatch

startBatch(): void
Allow for manipulation of elements without triggering multiple style calculations or multiple redraws. http://js.cytoscape.org/#cy.batch

Starts batching manually (useful for asynchronous cases).

Returns void
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:490

unmount

unmount(): void
Remove the instance from its current container. http://js.cytoscape.org/#cy.unmount

This function sets the instance to be headless after unmounting from the current container.

Returns void
- Defined in lara-framework/Lara-JS/src-api/libs/cytoscape-3.26.0.d.ts:518

Interface CoreGraphManipulation

Hierarchy (view full)

Index

Methods

Methods

$

Parameters

Returns CollectionReturnValue

$id

Parameters

Returns CollectionReturnValue

add

Parameters

Returns CollectionReturnValue

batch

Parameters

Returns void

Returns void

collection

Parameters

Returns CollectionReturnValue

destroy

Returns void

destroyed

Returns boolean

edges

Parameters

Returns cytoscape.EdgeCollection

elements

Parameters

Returns CollectionReturnValue

endBatch

Returns void

filter

Parameters

Returns CollectionReturnValue

getElementById

Parameters

Returns CollectionReturnValue

hasElementWithId

Parameters

Returns boolean

mount

Parameters

Returns void

nodes

Parameters

Returns cytoscape.NodeCollection

remove

Parameters

Returns CollectionReturnValue

startBatch

Returns void

unmount

Returns void

Settings

On This Page