Skip to content

eles.max(valFn, thisArg?)

eles.max — Collection > Iteration and aggregation. Cytoscape.js signatures, parameters and return contract.

eles.max — Collection › Iteration and aggregation

Preview · Collection › Iteration and aggregation

Read in the complete API reference · All API members

// The element maximizing valFn, with its value
eles.max(valFn: ( ele: Collection<NodeData, EdgeData, Data>, i: number, eles: Collection<NodeData, EdgeData, Data>, ) => number, thisArg?: unknown): { value: number; ele: Collection<NodeData, EdgeData, Data> | undefined }

The element maximizing valFn, with its value.

Parameters
NameDescription
valFn: ( ele: Collection<NodeData, EdgeData, Data>, i: number, eles: Collection<NodeData, EdgeData, Data>, ) => number

( ele, i, eles) => number

thisArg: unknown?

optional receiver for the callback

Returns { value: number; ele: Collection<NodeData, EdgeData, Data> | undefined }

{ value, ele }, or { value: -Infinity, ele: undefined } when the collection is empty

Example

const result = cy.nodes().max(node => node.data('score'));
console.log(result.value); // 3

Example graph and handle setup