Skip to content

eles.neighborhood(criterion?)

eles.neighborhood — Collection > Traversing > Incidence and neighbourhood. Cytoscape.js signatures, parameters and return contract.

eles.neighborhood — Collection › Traversing › Incidence and neighbourhood

Preview · Collection › Traversing › Incidence and neighbourhood

Read in the complete API reference · All API members

// The open neighbourhood: the incident edges and the nodes on their far ends, ignoring edge direction, excluding the collection's own elements
eles.neighborhood(criterion?: FilterLike<NodeData, EdgeData>): Collection<NodeData, EdgeData>

The open neighbourhood: the incident edges and the nodes on their far ends, ignoring edge direction, excluding the collection's own elements.

Parameters
NameDescription
criterion: FilterLike<NodeData, EdgeData>?

an optional query object or predicate to filter the result

Fields of criterion
NameDescription
group: GroupName?

restrict to one group

selected: boolean?

require the element (not) to be selected

selectable: boolean?

whether the element may be selected by the user

locked: boolean?

whether the element is locked in place

grabbed: boolean?

whether the user is dragging the element

grabbable: boolean?

whether the element may be dragged

active: boolean?

whether the element is under an active press

hovered: boolean?

whether the pointer is over the element

emphasized: boolean?

whether the element is in the current emphasis (* cy.emphasize())

parent: boolean?

structural (nodes only): has at least one child

childless: boolean?

structural (nodes only): has no children — exactly { parent: false }

child: boolean?

structural (nodes only): has a parent

orphan: boolean?

structural (nodes only): has no parent — exactly { child: false }

collapsed: boolean?

whether this compound parent is in collapsed miniature state (nodes only)

data: QueryData<Data>?

data-sidecar conditions per key; a bare value means equality. Typed, the keys are the queried elements' fields.

Returns Collection<NodeData, EdgeData>

the neighbouring edges and nodes

Example

console.log(eles.neighborhood().map(ele => ele.id())); // []

Example graph and handle setup

Also spelled eles.openNeighborhood.

See

Collection#closedNeighborhood to include these nodes