Skip to content

cy.filter(query)

cy.filter — Core > Accessing elements. Cytoscape.js signatures, parameters and return contract.

cy.filter — Core › Accessing elements

Preview · Core › Accessing elements

Read in the complete API reference · All API members

// Filter the whole graph
cy.filter(query: FilterLike<NodeData, EdgeData>): Collection<NodeData, EdgeData>

Filter the whole graph. Identical to elements( query), kept for symmetry with eles.filter().

Parameters
NameDescription
query: FilterLike<NodeData, EdgeData>

a query object or an ( ele) => boolean predicate

Fields of query
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 matching elements

Example

console.log(cy.filter(ele => ele.isNode()).length); // 3

Example graph and handle setup

Also spelled cy.$.