diff options
| author |   Michael Lando <ml636r@att.com> | 2017-02-19 10:28:42 +0200 |
|---|---|---|
| committer | Michael Lando <ml636r@att.com> | 2017-02-19 10:51:01 +0200 |
| commit | 451a3400b76511393c62a444f588a4ed15f4a549 (patch) | |
| tree | e4f5873a863d1d3e55618eab48b83262f874719d /catalog-ui/typings/cytoscape/cytoscape.d.ts | |
| parent | 5abfe4e1fb5fae4bbd5fbc340519f52075aff3ff (diff) | |
Initial OpenECOMP SDC commit
Change-Id: I0924d5a6ae9cdc161ae17c68d3689a30d10f407b
Signed-off-by: Michael Lando <ml636r@att.com>
Diffstat (limited to 'catalog-ui/typings/cytoscape/cytoscape.d.ts')
| -rw-r--r-- | catalog-ui/typings/cytoscape/cytoscape.d.ts | 3095 |
1 files changed, 3095 insertions, 0 deletions
diff --git a/catalog-ui/typings/cytoscape/cytoscape.d.ts b/catalog-ui/typings/cytoscape/cytoscape.d.ts new file mode 100644 index 0000000000..e10b6273ae --- /dev/null +++ b/catalog-ui/typings/cytoscape/cytoscape.d.ts @@ -0,0 +1,3095 @@ +// Type definitions for Cytoscape.js 2.4.2 +// Project: http://js.cytoscape.org/ +// Definitions by: Fabian Schmidt +// +// Translation from Objects in help to Typescript interface. +// cy --> Cy.Instance +// the core +// ele --> Cy.CollectionFirst +// a collection of a single element (node or edge) +// eles --> Cy.Collection +// a collection of one or more elements (nodes and edges) +// node --> Cy.CollectionFirstNode +// a collection of a single node +// nodes -> Cy.CollectionNodes +// a collection of one or more nodes +// edge --> Cy.CollectionFirstEdge +// a collection of a single edge +// edges -> Cy.CollectionEdges +// a collection of one or more edges +// +// The library makes a diferrence between input and output parameter due to the dynamic behaviour of the Cytoscape library. +// For a input parameter it will always expect: +// - Cy.Collection +// The input can be any element (node and edge) collection. +// - Cy.CollectionNodes +// The input must be a node collection. +// - Cy.CollectionEdges +// The input must be a edge collection. +// - Cy.CollectionFirst +// The input must be a single element. +// - Cy.CollectionFirstNode +// The inut must be a single node. +// - Cy.CollectionFirstEdge +// The input must be a single edge. +// +// For a output of a function it will always give: +// - Cy.CollectionElements +// The output is a collection of node and edge elements OR single element. +// - Cy.CollectionEdges +// The output is a collection of edge elements OR single edge. +// - Cy.CollectionNodes +// The output is a collection of node elements OR single node. + +declare module Cy { + /** + * See http://js.cytoscape.org/#selectors for details about writing selectors. + */ + import ClipExtent = d3.geo.ClipExtent; + type Selector = string; + + /** + * Possbile values are 'additive' or 'single'. + */ + type SelectionType = string; + + /** + * Possible values are 'nodes' or 'edges'. + */ + type ElementGroup = string; + + /** + * Possible values are 'x' or 'y'. + */ + type PositionDimension = string; + + /** + * Usually temp or nonserialisable data can be stored. + */ + type Scratchpad = any; + + interface CollectionElements extends CollectionEdges, CollectionNodes, CollectionFirstElement { + //Intentionally empty. + } + + interface Extent { + x1: number, y1: number, x2: number, y2: number, w: number, h: number + } + + interface CollectionEdges extends Collection, CollectionFirstEdge, + CollectionEdgesTraversing { + } + + interface CollectionNodes extends Collection, CollectionFirstNode, + CollectionNodesMetadata, CollectionNodesPosition, CollectionNodesTraversing, CollectionNodesCompound { + } + + interface Collection extends CollectionFirst, + CollectionManipulation, CollectionEvents, CollectionData, CollectionPosition, CollectionLayout, CollectionSelection, CollectionStyle, CollectionAnimation, CollectionComparision, CollectionIteration, CollectionBuildingUnion, CollectionAlgorithms, CollectionTraversing { + } + + interface CollectionFirstElement extends CollectionFirstEdge, CollectionFirstNode { + //Intentionally empty. + } + + interface CollectionFirstEdge extends CollectionFirst, + CollectionFirstEdgeData, CollectionFirstEdgeTraversing { + } + + interface CollectionFirstNode extends CollectionFirst, + CollectionFirstNodeMetadata, CollectionFirstNodePosition, CollectionFirstNodeCompound { + } + + interface CollectionFirst extends CollectionFirstManipulation, CollectionFirstData, CollectionFirstPosition, CollectionFirstSelection, CollectionFirstStyle, CollectionFirtsAnimation { + } + + interface CollectionManipulation { + /** + * Remove the elements from the graph. + */ + remove(): CollectionElements; + + /** + * Put removed elements back into the graph. + */ + restore(): CollectionElements; + + /** + * Get a new collection containing clones (i.e. copies) of the elements in the calling collection. + */ + clone(): CollectionElements; + /** + * Get a new collection containing clones (i.e. copies) of the elements in the calling collection. + */ + copy(): CollectionElements; + + /** + * Effectively move edges to different nodes. The modified (actually new) elements are returned. + */ + move(location: { source?: string, target?: string }): CollectionEdges; + /** + * Effectively move nodes to different parent node. The modified (actually new) elements are returned. + */ + move(location: { parent: string }): CollectionNodes; + } + + interface CollectionEvents { + //TODO: http://js.cytoscape.org/#collection/events + //TODO: http://js.cytoscape.org/#collection/events + + // on(event:string, callback: () => void); + + on(events: string, any); + } + + interface CollectionData { + //http://js.cytoscape.org/#collection/data + + // The following fields are immutable: + //id: The id field is used to uniquely identify an element in the graph. + //source & target : These fields define an edge's relationship to nodes, and this relationship can not be changed after creation. + //parent: The parent field defines the parent (compound) node. + + /** + * Remove developer-defined data associated with the elements. + */ + removeData(): CollectionElements; + /** + * Remove developer-defined data associated with the elements. + * + * @param names A space-separated list of fields to delete. + */ + removeData(names: string): CollectionElements; + /** + * Remove developer-defined data associated with the elements. + */ + removeAttr(): CollectionElements; + /** + * Remove developer-defined data associated with the elements. + * + * @param names A space-separated list of fields to delete. + */ + removeAttr(names: string): CollectionElements; + + /** + * Get an array of the plain JavaScript object representation of all elements in the collection. + */ + jsons(): string[]; + } + interface CollectionNodesMetadata { + //http://js.cytoscape.org/#collection/metadata + + /** + * Get the maximum degree of the nodes in the collection. + * + * For a node, the degree is the number of edge connections it has. Each time a node is referenced as source or target of an edge in the graph, that counts as an edge connection. + * + * For a set of nodes, the the total degree is the total number of edge connections to nodes in the set. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + maxDegree(includeLoops: boolean): number; + /** + * Get the minimum indegree of the nodes in the collection. + * + * For a node, the indegree is the number of incoming edge connections it has. Each time a node is referred to as target of an edge in the graph, that counts as an incoming edge connection. + * + * For a set of nodes, the the total degree is the total number of edge connections to nodes in the set. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + minIndegree(includeLoops: boolean): number; + /** + * Get the maximum indegree of the nodes in the collection. + * + * For a node, the indegree is the number of incoming edge connections it has. Each time a node is referred to as target of an edge in the graph, that counts as an incoming edge connection. + * + * For a set of nodes, the the total degree is the total number of edge connections to nodes in the set. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + maxIndegree(includeLoops: boolean): number; + /** + * Get the minimum outdegree of the nodes in the collection. + * + * For a node, the outdegree is the number of outgoing edge connections it has. Each time a node is referred to as source of an edge in the graph, that counts as an outgoing edge connection. + * + * For a set of nodes, the the total degree is the total number of edge connections to nodes in the set. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + minOutdegree(includeLoops: boolean): number; + /** + * Get the maximum outdegree of the nodes in the collection. + * + * For a node, the outdegree is the number of outgoing edge connections it has. Each time a node is referred to as source of an edge in the graph, that counts as an outgoing edge connection. + * + * For a set of nodes, the the total degree is the total number of edge connections to nodes in the set. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + maxOutdegree(includeLoops: boolean): number; + } + + interface BoundingBox { + x1: number; + x2: number; + y1: number; + y2: number; + w: number; + h: number; + } + interface CollectionPosition { + //http://js.cytoscape.org/#collection/position--dimensions + + /** + * Get the bounding box of the elements in model coordinates. + * + * @param options An object containing options for the function. + */ + boundingBox(options: BoundingBoxOptions): BoundingBox; + /** + * Get the bounding box of the elements in model coordinates. + * + * @param options An object containing options for the function. + */ + boundingbox(options?: BoundingBoxOptions): BoundingBox; + + /** + * Get the bounding box of the elements in rendered coordinates. + * + * @param options An object containing options for the function. + */ + renderedBoundingBox(options?: BoundingBoxOptions): BoundingBox; + /** + * Get the bounding box of the elements in rendered coordinates. + * + * @param options An object containing options for the function. + */ + renderedBoundingbox(options?: BoundingBoxOptions): BoundingBox; + } + interface CollectionNodesPosition { + //http://js.cytoscape.org/#collection/position--dimensions + + /** + * Set the positions functionally. + * + * @param callback A callback function that returns the position to set for each element. + * i - The index of the element when iterating over the elements in the collection. + * ele - The element being iterated over for which the function should return a position to set. + */ + positions(callback: (i: number, ele: CollectionNodes) => Position): CollectionNodes; + /** + * Set positions for all nodes based on a single position object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + positions(pos: Position): CollectionNodes; + + /** + * Set the positions functionally. + * + * @param callback A callback function that returns the position to set for each element. + * i - The index of the element when iterating over the elements in the collection. + * ele - The element being iterated over for which the function should return a position to set. + */ + modelPositions(callback: (i: number, ele: CollectionNodes) => Position): CollectionNodes; + /** + * Set positions for all nodes based on a single position object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + modelPositions(pos: Position): CollectionNodes; + + /** + * Set the positions functionally. + * + * @param callback A callback function that returns the position to set for each element. + * i - The index of the element when iterating over the elements in the collection. + * ele - The element being iterated over for which the function should return a position to set. + */ + points(callback: (i: number, ele: CollectionNodes) => Position): CollectionNodes; + /** + * Set positions for all nodes based on a single position object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + points(pos: Position): CollectionNodes; + + /** + * Allow the user to grab the nodes. + */ + grabify(): CollectionNodes; + + /** + * Disallow the user to grab the nodes. + */ + ungrabify(): CollectionNodes; + + /** + * Lock the nodes such that their positions can not be changed. + */ + lock(): CollectionNodes; + /** + * Unlock the nodes such that their positions can be changed. + */ + unlock(): CollectionNodes; + } + interface CollectionLayout { + // http://js.cytoscape.org/#collection/layout + + /** + * Run a layout on the elements in the calling collection, algorithmically positioning the nodes. + * This function is useful for running a layout on a subset of the elements in the graph. + * + * @param options The layout options. + */ + layout(options: LayoutOptions): CollectionElements; + + /** + * Get a new layout, which can be used to algorithmically position the nodes in the collection. + * This function is useful for running a layout on a subset of the elements in the graph, perhaps in parallel to other layouts. + * + * You must specify options.name with the name of the layout you wish to use. + * + * Note: that you must call layout.run() in order for it to affect the graph. + * + * @param options The layout options. + */ + makeLayout(options: LayoutOptions): LayoutInstance; + /** + * Get a new layout, which can be used to algorithmically position the nodes in the collection. + * This function is useful for running a layout on a subset of the elements in the graph, perhaps in parallel to other layouts. + * + * You must specify options.name with the name of the layout you wish to use. + * + * Note: that you must call layout.run() in order for it to affect the graph. + * + * @param options The layout options. + */ + createLayout(options: LayoutOptions): LayoutInstance; + } + interface CollectionSelection { + // http://js.cytoscape.org/#collection/selection + + /** + * Make the elements selected (NB other elements outside the collection are not affected). + */ + select(): CollectionElements; + + /** + * Make the elements not selected (NB other elements outside the collection are not affected). + */ + unselect(): CollectionElements; + /** + * Make the elements not selected (NB other elements outside the collection are not affected). + */ + deselect(): CollectionElements; + + /** + * Make the selection states of the elements mutable. + */ + selectify(): CollectionElements; + + /** + * Make the selection states of the elements immutable. + */ + unselectify(): CollectionElements; + } + interface CollectionStyle { + // http://js.cytoscape.org/#collection/style + + /** + * Add classes to elements. + * + * @param classes A space-separated list of class names to add to the elements. + */ + addClass(classes: string): CollectionElements; + + /** + * Remove classes from elements. + * + * @param classes A space-separated list of class names to remove from the elements. + */ + removeClass(classes: string): CollectionElements; + + /** + * Toggle whether the elements have the specified classes. + * + * @param classes A space-separated list of class names to toggle on the elements. + * @param toggle [optional] Instead of automatically toggling, adds the classes on truthy values or removes them on falsey values. + */ + toggleClass(classes: string, toggle?: boolean): CollectionElements; + + /** + * Add classes to the elements, and then remove the classes after a specified duration. + * + * @param classes A space-separated list of class names to flash on the elements. + * @param duration [optional] The duration in milliseconds that the classes should be added on the elements. After the duration, the classes are removed. + */ + flashClass(classes: string, duration?: number): CollectionElements; + + + /** + * Get a name-value pair object containing visual style properties and their values for the element. + */ + style(): Css.ElementCss; + /** + * Get a particular style property value. + * + * @param name The name of the visual style property to get. + */ + style(name: string): Css.ElementCss; + + /** + * Get a name-value pair object containing visual style properties and their values for the element. + */ + css(): Css.ElementCss; + /** + * Get a particular style property value. + * + * @param name The name of the visual style property to get. + */ + css(name: string): Css.ElementCss; + + /** + * Get a name-value pair object containing visual style properties and their values for the element. + */ + bypass(): Css.ElementCss; + /** + * Get a particular style property value. + * + * @param name The name of the visual style property to get. + */ + bypass(name: string): Css.ElementCss; + + + /** + * Set the specified visual style property for the elements. + * + * You should use this function very sparingly, because it overrides the style of an element, despite the state and classes that it has. In general, it's much better to specify a better stylesheet at initialisation that reflects your application state rather than programmatically modifying style. + * + * If you would like to remove a particular overridden style property, set null to it. + * + * @param name The name of the property to set. + * @param value The value to set to the visual style property. + */ + style(name: string, value: string): CollectionElements; + /** + * Set several visual style properties at once for the elements. + * + * You should use this function very sparingly, because it overrides the style of an element, despite the state and classes that it has. In general, it's much better to specify a better stylesheet at initialisation that reflects your application state rather than programmatically modifying style. + * + * If you would like to remove a particular overridden style property, set null to it. + * + * @param props An object with name-value pairs representing properties to set on the elements. + */ + style(props: Css.ElementCss): CollectionElements; + + /** + * Set the specified visual style property for the elements. + * + * You should use this function very sparingly, because it overrides the style of an element, despite the state and classes that it has. In general, it's much better to specify a better stylesheet at initialisation that reflects your application state rather than programmatically modifying style. + * + * If you would like to remove a particular overridden style property, set null to it. + * + * @param name The name of the property to set. + * @param value The value to set to the visual style property. + */ + css(name: string, value: string): CollectionElements; + /** + * Set several visual style properties at once for the elements. + * + * You should use this function very sparingly, because it overrides the style of an element, despite the state and classes that it has. In general, it's much better to specify a better stylesheet at initialisation that reflects your application state rather than programmatically modifying style. + * + * If you would like to remove a particular overridden style property, set null to it. + * + * @param props An object with name-value pairs representing properties to set on the elements. + */ + css(props: Css.ElementCss): CollectionElements; + + /** + * Set the specified visual style property for the elements. + * + * You should use this function very sparingly, because it overrides the style of an element, despite the state and classes that it has. In general, it's much better to specify a better stylesheet at initialisation that reflects your application state rather than programmatically modifying style. + * + * If you would like to remove a particular overridden style property, set null to it. + * + * @param name The name of the property to set. + * @param value The value to set to the visual style property. + */ + bypass(name: string, value: string): CollectionElements; + /** + * Set several visual style properties at once for the elements. + * + * You should use this function very sparingly, because it overrides the style of an element, despite the state and classes that it has. In general, it's much better to specify a better stylesheet at initialisation that reflects your application state rather than programmatically modifying style. + * + * If you would like to remove a particular overridden style property, set null to it. + * + * @param props An object with name-value pairs representing properties to set on the elements. + */ + bypass(props: Css.ElementCss): CollectionElements; + + /** + * Removes all overridden style of the elements. + */ + removeStyle(): CollectionElements; + /** + * Removes particular overridden style properties of the elements. + * + * @param names A space-separated list of property names for which overridden styles will be removed. + */ + removeStyle(names: string): CollectionElements; + /** + * Removes all overridden style of the elements. + */ + removeCss(): CollectionElements; + /** + * Removes particular overridden style properties of the elements. + * + * @param names A space-separated list of property names for which overridden styles will be removed. + */ + removeCss(names: string): CollectionElements; + /** + * Removes all overridden style of the elements. + */ + removeBypass(): CollectionElements; + /** + * Removes particular overridden style properties of the elements. + * + * @param names A space-separated list of property names for which overridden styles will be removed. + */ + removeBypass(names: string): CollectionElements; + } + interface CollectionAnimation { + // http://js.cytoscape.org/#collection/animation + + /** + * Animate the elements. + * + * Note that you can specify only one of position and renderedPosition: You can not animate to two positions at once. + * + * @param anis An object containing the details of the animation. + * position - A position to which the elements will be animated. + * renderedPosition - A rendered position to which the elements will be animated. + * style - An object containing name-value pairs of style properties to animate. + * @param options An object containing animation options. + * duration - The duration of the animation in milliseconds. + * queue - A boolean indicating whether to queue the animation. + * complete - A function to call when the animation is done. + * step - A function to call each time the animation steps. + */ + animate(anis: { + postion?: Position, + renderedPosition?: Position, + style?: Css.ElementCss + }, options?: { + duration?: number, + queue?: boolean, + complete?: () => void, + step?: () => void + }): CollectionElements; + + /** + * Add a delay between animations for the elements. + * + * @param duration How long the delay should be in milliseconds. + * @param complete A function to call when the delay is complete. + */ + delay(duration: number, complete?: () => void): CollectionElements; + + /** + * Stop all animations that are currently running. + * + * @param clearQueue A boolean, indicating whether the queue of animations should be emptied. + * @param jumpToEnd A boolean, indicating whether the currently-running animations should jump to their ends rather than just stopping midway. + */ + stop(clearQueue?: boolean, jumpToEnd?: boolean): CollectionElements; + + /** + * Remove all queued animations for the elements. + */ + clearQueue(): CollectionElements; + } + interface CollectionComparision { + // http://js.cytoscape.org/#collection/comparison + + /** + * Determine whether this collection contains exactly the same elements as another collection. + * + * @param eles The other elements to compare to. + */ + same(eles: Collection): boolean; + + /** + * Determine whether this collection contains any of the same elements as another collection. + * + * @param eles The other elements to compare to. + */ + anySame(eles: Collection): boolean; + + /** + * Determine whether all elements in the specified collection are in the neighbourhood of the calling collection. + * + * @param eles The other elements to compare to. + */ + allAreNeighbors(eles: Collection): boolean; + /** + * Determine whether all elements in the specified collection are in the neighbourhood of the calling collection. + * + * @param eles The other elements to compare to. + */ + allAreNeighbours(eles: Collection): boolean; + + /** + * Determine whether any element in this collection matches a selector. + * + * @param selector The selector to match against. + */ + is(selector: Selector): boolean; + + /** + * Determine whether all elements in the collection match a selector. + * @param selector The selector to match against. + */ + allAre(selector: Selector): boolean; + + /** + * Determine whether any element in this collection satisfies the specified test function. + * + * @param test The test function that returns truthy values for elements that satisfy the test and falsey values for elements that do not satisfy the test. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being tested. + * @param thisArg [optional] The value for this within the test function. + */ + some(test: (ele: CollectionElements, i: number, eles: CollectionElements) => boolean, thisArg?: any): boolean; + + /** + * Determine whether all elements in this collection satisfy the specified test function. + * + * @param test The test function that returns truthy values for elements that satisfy the test and falsey values for elements that do not satisfy the test. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being tested. + * @param thisArg [optional] The value for this within the test function. + */ + every(test: (ele: CollectionElements, i: number, eles: CollectionElements) => boolean, thisArg?: any): boolean; + } + interface CollectionIteration { + // http://js.cytoscape.org/#collection/iteration + + /** + * Get the number of elements in the collection. + */ + size(): number; + /** + * Get the number of elements in the collection. + */ + length: number; + + /** + * Get whether the collection is empty, meaning it has no elements. + */ + empty(): boolean; + /** + * Get whether the collection is nonempty, meaning it has elements. + */ + nonempty(): boolean; + + /** + * Iterate over the elements in the collection. + * + * Note that although this function is convenient in some cases, it is less efficient than making your own loop. + * + * @param each The function executed each iteration. + * i - The index of the element in the collection. + * ele - The element at the current index. + */ + each(each: (i: number, ele: CollectionElements) => void); + + /** + * Iterate over the elements in the collection using an implementation like the native array function namesake. + * + * This function behaves like Array.prototype.forEach() with minor changes for convenience: + * You can exit the iteration early by returning false in the iterating function. The Array.prototype.forEach() implementation does not support this, but it is included anyway on account of its utility. + * + * @param each The function executed each iteration. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being iterated. + * @param thisArg [optional] The value for this within the iterating function. + */ + forEach(each: (ele: CollectionElements, i: number, eles: CollectionElements) => void|boolean, thisArg?: any); + + /** + * Get an element at a particular index in the collection. + * + * You may use eles[i] in place of eles.eq(i) as a more performant alternative. + * + * @param index The index of the element to get. + */ + eq(index: number): CollectionElements; + /** + * Get an element at a particular index in the collection. + * + * @param index The index of the element to get. + */ + [index: number]: CollectionElements; + /** + * Get the first element in the collection. + */ + first(): CollectionElements; + /** + * Get the last element in the collection. + */ + last(): CollectionElements; + + /** + * Get a subset of the elements in the collection based on specified indices. + * + * @param start [optional] An integer that specifies where to start the selection. The first element has an index of 0. Use negative numbers to select from the end of an array. + * @param end [optional] An integer that specifies where to end the selection. If omitted, all elements from the start position and to the end of the array will be selected. Use negative numbers to select from the end of an array. + */ + slice(start?: number, end?: number): CollectionElements; + } + interface CollectionBuildingUnion { + /** + * Get a new collection, resulting from adding the collection with another one + * + * @param eles The elements to add. + */ + (eles: Collection): CollectionElements; + /** + * Get a new collection, resulting from adding the collection with another one + * + * @param elesArray An array of elements to add. + */ + (elesArray: Collection[]): CollectionElements; + /** + * Get a new collection, resulting from adding the collection with another one + * + * @param selector Elements in the graph matching this selector are added. + */ + (selector: Selector): CollectionElements; + } + interface CollectionBuildingDifference { + /** + * Get a new collection, resulting from the collection without some specified elements. + * + * @param eles The elements that will not be in the resultant collection. + */ + (eles: Collection): CollectionElements; + /** + * Get a new collection, resulting from the collection without some specified elements. + * + * @param selector Elements from the calling collection matching this selector will not be in the resultant collection. + */ + (selector: Selector): CollectionElements; + } + interface CollectionBuildingIntersection { + /** + * Get the elements in both this collection and another specified collection. + * + * @param eles The elements to intersect with. + */ + (eles: Collection): CollectionElements; + /** + * Get the elements in both this collection and another specified collection. + * + * @param selector A selector representing the elements to intersect with. All elements in the graph matching the selector are used as the passed collection. + */ + (selector: Selector): CollectionElements; + } + interface CollectionSymmetricDifference { + /** + * Get the elements that are in the calling collection or the passed collection but not in both. + * + * @param eles The elements to apply the symmetric difference with. + */ + (eles: Collection): CollectionElements; + /** + * Get the elements that are in the calling collection or the passed collection but not in both. + * + * @param selector A selector representing the elements to apply the symmetric difference with. All elements in the graph matching the selector are used as the passed collection. + */ + (selector: Selector): CollectionElements; + } + interface CollectionBuildingUnion { + // http://js.cytoscape.org/#collection/building--filtering + + union: CollectionBuildingUnion; + //[index: "u"]: CollectionBuildingUnion; + add: CollectionBuildingUnion; + //[index: "+"]: CollectionBuildingUnion; + or: CollectionBuildingUnion; + //[index: "|"]: CollectionBuildingUnion; + + difference: CollectionBuildingDifference; + //[index: "\\"]: CollectionBuildingDifference; + not: CollectionBuildingDifference; + //[index: "!"]: CollectionBuildingDifference; + relativeComplement(): CollectionBuildingDifference; + //[index: "-"]: CollectionBuildingDifference; + + /** + * Get all elements in the graph that are not in the calling collection. + */ + absoluteComplement(): CollectionElements; + /** + * Get all elements in the graph that are not in the calling collection. + */ + abscomp(): CollectionElements; + /** + * Get all elements in the graph that are not in the calling collection. + */ + complement(): CollectionElements; + + intersection: CollectionBuildingIntersection; + intersect: CollectionBuildingIntersection; + and: CollectionBuildingIntersection; + //[index: "n"]: CollectionBuildingIntersection; + //[index: "&"]: CollectionBuildingIntersection; + //[index: "."]: CollectionBuildingIntersection; + + symmetricDifference: CollectionSymmetricDifference; + symdiff: CollectionSymmetricDifference; + xor: CollectionSymmetricDifference; + //[index: "^"]: CollectionSymmetricDifference; + //[index: "(+)"]: CollectionSymmetricDifference; + //[index: "(-)"]: CollectionSymmetricDifference; + + //[index: string]: CollectionBuildingDifference |CollectionBuildingUnion | CollectionBuildingIntersection | CollectionSymmetricDifference; + + /** + * Perform a traditional left/right diff on the two collections. + * + * @param eles The elements on the right side of the diff. + */ + diff(eles: Collection): CollectionElements; + /** + * Perform a traditional left/right diff on the two collections. + * + * @param selector A selector representing the elements on the right side of the diff. All elements in the graph matching the selector are used as the passed collection. + * @return This function returns a plain object of the form { left, right, both } where + * left - is the set of elements only in the calling (i.e. left) collection, + * right - is the set of elements only in the passed (i.e. right) collection, and + * both - is the set of elements in both collections. + */ + diff(selector: Selector): { + left: CollectionElements, + right: CollectionElements, + both: CollectionElements + }; + + /** + * Get a new collection containing elements that are accepted by the specified filter. + * + * @param selector The selector to match against. + */ + filter(selector: Selector): CollectionElements; + /** + * Get a new collection containing elements that are accepted by the specified filter. + * + * @filter selector The filter function that returns true for elements to include. + * i - The index of the current element being considered. + * ele - The element being considered. + */ + filter(filter: (i: number, ele: CollectionElements) => boolean): CollectionElements; + /** + * Get the nodes that match the specified selector. + * + * @param selector The selector to match against. + */ + nodes(selector: Selector): CollectionNodes; + /** + * Get the edges that match the specified selector. + * + * @param selector The selector to match against. + */ + edges(selector: Selector): CollectionEdges; + + /** + * Get a new collection containing elements that are accepted by the specified filter, using an implementation like the standard array namesake. + * + * @param filter The filter function that returns truthy values for elements to include and falsey values for elements to exclude. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being filtered. + * @param thisArg [optional] The value for this within the iterating function. + */ + filterFn(filter: (ele: CollectionElements, i: number, eles: CollectionElements) => boolean, thisArg?: any): CollectionElements; + /** + * Get a new collection containing elements that are accepted by the specified filter, using an implementation like the standard array namesake. + * + * @param filter The filter function that returns truthy values for elements to include and falsey values for elements to exclude. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being filtered. + * @param thisArg [optional] The value for this within the iterating function. + */ + fnFilter(filter: (ele: CollectionElements, i: number, eles: CollectionElements) => boolean, thisArg?: any): CollectionElements; + /** + * Get a new collection containing elements that are accepted by the specified filter, using an implementation like the standard array namesake. + * + * @param filter The filter function that returns truthy values for elements to include and falsey values for elements to exclude. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being filtered. + * @param thisArg [optional] The value for this within the iterating function. + */ + stdFilter(filter: (ele: CollectionElements, i: number, eles: CollectionElements) => boolean, thisArg?: any): CollectionElements; + + /** + * Get a new collection containing the elements sorted by the specified comparison function. + * + * @param sort The sorting comparison function that returns a negative number for ele1 before ele2, 0 for ele1 same as ele2, or a positive number for ele1 after ele2. + */ + sort(sort: (ele1: CollectionElements, ele2: CollectionElements) => number): CollectionElements; + + /** + * Get an array containing values mapped from the collection. + * + * @param fn The function that returns the mapped value for each element. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being mapped. + * @param thisArg [optional] The value for this within the iterating function. + */ + map(fn: (ele: CollectionElements, i: number, eles: CollectionElements) => any, thisArg?: any): any[]; + + /** + * Find a minimum value in a collection. + * + * @param fn The function that returns the value to compare for each element. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being mapped. + * @param thisArg [optional] The value for this within the iterating function. + */ + min(fn: (ele: CollectionElements, i: number, eles: CollectionElements) => any, thisArg?: any): { + /** + * The minimum value found. + */ + value: any, + /** + * The element that corresponds to the minimum value. + */ + ele: CollectionElements + }; + + /** + * Find a maximum value and the corresponding element. + * + * @param fn The function that returns the value to compare for each element. + * ele - The current element. + * i - The index of the current element. + * eles - The collection of elements being mapped. + * @param thisArg [optional] The value for this within the iterating function. + */ + max(fn: (ele: CollectionElements, i: number, eles: CollectionElements) => any, thisArg?: any): { + /** + * The maximum value found. + */ + value: any, + /** + * The element that corresponds to the maximum value. + */ + ele: CollectionElements + }; + } + interface CollectionTraversing { + // http://js.cytoscape.org/#collection/traversing + + /** + * Get the open neighbourhood of the elements. + * + * The neighbourhood returned by this function is a bit different than the traditional definition of a "neighbourhood": This returned neighbourhood includes the edges connecting the collection to the neighbourhood. This gives you more flexibility. + * An open neighbourhood is one that does not include the original set of elements. If unspecified, a neighbourhood is open by default. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + neighborhood(selector?: Selector): CollectionElements; + /** + * Get the open neighbourhood of the elements. + * + * The neighbourhood returned by this function is a bit different than the traditional definition of a "neighbourhood": This returned neighbourhood includes the edges connecting the collection to the neighbourhood. This gives you more flexibility. + * An open neighbourhood is one that does not include the original set of elements. If unspecified, a neighbourhood is open by default. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + openNeighborhood(selector?: Selector): CollectionElements; + /** + * Get the closed neighbourhood of the elements. + * + * The neighbourhood returned by this function is a bit different than the traditional definition of a "neighbourhood": This returned neighbourhood includes the edges connecting the collection to the neighbourhood. This gives you more flexibility. + * A closed neighbourhood is one that does include the original set of elements. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + closedNeighborhood(selector?: Selector): CollectionElements; + } + interface CollectionEdgesTraversing { + // http://js.cytoscape.org/#collection/traversing + + /** + * Get the nodes connected to the edges in the collection + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + connectedNodes(selector?: Selector): CollectionNodes; + + /** + * Get source nodes connected to the edges in the collection. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + sources(selector?: Selector): CollectionNodes; + + /** + * Get target nodes connected to the edges in the collection. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + targets(selector?: Selector): CollectionNodes; + + /** + * Get edges parallel to those in the collection. + * + * Two edges are said to be parallel if they connect the same two nodes. Any two parallel edges may connect nodes in the same direction, in which case the edges share the same source and target. They may alternatively connect nodes in the opposite direction, in which case the source and target are reversed in the second edge. + * That is: + * - edge1.source().id() === edge2.source().id() + * && edge1.target().id() === edge2.target().id() + * OR + * - edge1.source().id() === edge2.target().id() + * && edge1.target().id() === edge2.source().id() + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + parallelEdges(selector?: Selector): CollectionEdges; + + /** + * Get edges codirected to those in the collection. + * + * Two edges are said to be codirected if they connect the same two nodes in the same direction: The edges have the same source and target. + * That is: + * - edge1.source().id() === edge2.source().id() + * && edge1.target().id() === edge2.target().id() + + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + codirectedEdges(selector?: Selector): CollectionEdges; + } + interface CollectionNodesTraversing { + // http://js.cytoscape.org/#collection/traversing + + /** + * Get the edges connecting the collection to another collection. Direction of the edges does not matter. + * + * @param eles The other collection. + */ + edgesWith(eles: Collection): CollectionEdges; + /** + * Get the edges connecting the collection to another collection. Direction of the edges does not matter. + * + * @param selector The other collection, specified as a selector which is matched against all elements in the graph. + */ + edgesWith(selector: Selector): CollectionEdges; + + /** + * Get the edges coming from the collection (i.e. the source) going to another collection (i.e. the target). + * + * @param eles The other collection. + */ + edgesTo(eles: Collection): CollectionEdges; + /** + * Get the edges coming from the collection (i.e. the source) going to another collection (i.e. the target). + * + * @param selector The other collection, specified as a selector which is matched against all elements in the graph. + */ + edgesTo(selector: Selector): CollectionEdges; + + /** + * Get the edges connected to the nodes in the collection. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + connectedEdges(selector?: Selector): CollectionEdges; + + /** + * From the set of calling nodes, get the nodes which are leaves (i.e. no outgoing edges, as in a directed acyclic graph). + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + leaves(selector?: Selector): CollectionNodes; + + /** + * Get edges (and their targets) coming out of the nodes in the collection. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + outgoers(selector?: Selector): CollectionEdges; + + /** + * Recursively get edges (and their targets) coming out of the nodes in the collection (i.e. the outgoers, the outgoers' outgoers, ...). + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + successors(selector?: Selector): CollectionEdges; + + /** + * Get edges (and their sources) coming into the nodes in the collection. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + incomers(selector?: Selector): CollectionEdges; + + /** + * Recursively get edges (and their sources) coming into the nodes in the collection (i.e. the incomers, the incomers' incomers, ...). + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + predecessors(selector?: Selector): CollectionEdges; + } + interface SearchBreadthFirstOptions { + /** + * The root nodes (selector or collection) to start the search from. + */ + roots: Selector|Collection; + /** + * A handler function that is called when a node is visited in the search. The handler returns true when it finds the desired node, and it returns false to cancel the search. + * i - The index indicating this node is the ith visited node. + * depth - How many edge hops away this node is from the root nodes. + * v - The current node. + * e - The edge connecting the previous node to the current node. + * u - The previous node. + */ + visit?: (i: number, depth: number, v: CollectionNodes, e: CollectionEdges, u: CollectionNodes) => boolean; + /** + * A boolean indicating whether the algorithm should only go along edges from source to target (default false). + */ + directed?: boolean; + } + interface SearchBreadthFirstResult { + /** + * The path of the search. + * - The path returned includes edges such that if path[i] is a node, then path[i - 1] is the edge used to get to that node. + */ + path: CollectionElements; + /** + * The node found by the search + * - If no node was found, then found is empty. + * - If your handler function returns false, then the only the path up to that point is returned. + */ + found: CollectionNodes; + } + interface SearchDijkstraOptions { + /** + * The root node (selector or collection) where the algorithm starts. + */ + root: Selector|Collection; + + /** + * A function that returns the positive numeric weight for this edge. + * + * If no weight function is defined, a constant weight of 1 is used for each edge. + */ + weight?: (edge: CollectionEdges) => number; + + /** + * A boolean indicating whether the algorithm should only go along edges from source to target (default false). + */ + directed?: boolean; + } + interface SearchDijkstraResult { + /** + * Returns the distance from the source node to node. + */ + distanceTo: (node: CollectionFirstNode) => number; + + /** + * Returns a collection containing the shortest path from the source node to node. + * The path starts with the source node and includes the edges between the nodes in the path such that if pathTo(node)[i] is an edge, then pathTo(node)[i-1] is the previous node in the path and pathTo(node)[i+1] is the next node in the path. + */ + pathTo: (node: CollectionFirstNode) => Collection; + } + interface SearchAStarOptions { + } + interface SearchAStarResult { + } + interface CollectionAlgorithms { + // http://js.cytoscape.org/#collection/algorithms + + /** + * Perform a breadth-first search within the elements in the collection. + * + * Note that this function performs a breadth-first search on only the subset of the graph in the calling collection. + */ + breadthFirstSearch(options: SearchBreadthFirstOptions): SearchBreadthFirstResult; + /** + * Perform a breadth-first search within the elements in the collection. + * + * Note that this function performs a breadth-first search on only the subset of the graph in the calling collection. + * + * @param roots The root nodes (selector or collection) to start the search from. + * @param visit [optional] A handler function that is called when a node is visited in the search. The handler returns true when it finds the desired node, and it returns false to cancel the search. + * i - The index indicating this node is the ith visited node. + * depth - How many edge hops away this node is from the root nodes. + * v - The current node. + * e - The edge connecting the previous node to the current node. + * u - The previous node. + * @param directed [optional] A boolean indicating whether the search should only go along edges from source to target (default false). + */ + breadthFirstSearch(roots: Selector|Collection, + visit?: (i: number, depth: number, v: CollectionNodes, e: CollectionEdges, u: CollectionNodes) => boolean, + directed?: boolean): SearchBreadthFirstResult; + /** + * Perform a breadth-first search within the elements in the collection. + * + * Note that this function performs a breadth-first search on only the subset of the graph in the calling collection. + */ + bfs(options: SearchBreadthFirstOptions): SearchBreadthFirstResult; + /** + * Perform a breadth-first search within the elements in the collection. + * + * Note that this function performs a breadth-first search on only the subset of the graph in the calling collection. + * + * @param roots The root nodes (selector or collection) to start the search from. + * @param visit [optional] A handler function that is called when a node is visited in the search. The handler returns true when it finds the desired node, and it returns false to cancel the search. + * i - The index indicating this node is the ith visited node. + * depth - How many edge hops away this node is from the root nodes. + * v - The current node. + * e - The edge connecting the previous node to the current node. + * u - The previous node. + * @param directed [optional] A boolean indicating whether the search should only go along edges from source to target (default false). + */ + bfs(roots: Selector|Collection, + visit?: (i: number, depth: number, v: CollectionNodes, e: CollectionEdges, u: CollectionNodes) => boolean, + directed?: boolean): SearchBreadthFirstResult; + + /** + * Perform a depth-first search within the elements in the collection. + * + * Note that this function performs a depth-first search on only the subset of the graph in the calling collection. + */ + depthFirstSearch(options: SearchBreadthFirstOptions): SearchBreadthFirstResult; + /** + * Perform a depth-first search within the elements in the collection. + * + * Note that this function performs a depth-first search on only the subset of the graph in the calling collection. + * + * @param roots The root nodes (selector or collection) to start the search from. + * @param visit [optional] A handler function that is called when a node is visited in the search. The handler returns true when it finds the desired node, and it returns false to cancel the search. + * i - The index indicating this node is the ith visited node. + * depth - How many edge hops away this node is from the root nodes. + * v - The current node. + * e - The edge connecting the previous node to the current node. + * u - The previous node. + * @param directed [optional] A boolean indicating whether the search should only go along edges from source to target (default false). + */ + depthFirstSearch(roots: Selector|Collection, + visit?: (i: number, depth: number, v: CollectionNodes, e: CollectionEdges, u: CollectionNodes) => boolean, + directed?: boolean): SearchBreadthFirstResult; + /** + * Perform a depth-first search within the elements in the collection. + * + * Note that this function performs a depth-first search on only the subset of the graph in the calling collection. + */ + dfs(options: SearchBreadthFirstOptions): SearchBreadthFirstResult; + /** + * Perform a depth-first search within the elements in the collection. + * + * Note that this function performs a depth-first search on only the subset of the graph in the calling collection. + * + * @param roots The root nodes (selector or collection) to start the search from. + * @param visit [optional] A handler function that is called when a node is visited in the search. The handler returns true when it finds the desired node, and it returns false to cancel the search. + * i - The index indicating this node is the ith visited node. + * depth - How many edge hops away this node is from the root nodes. + * v - The current node. + * e - The edge connecting the previous node to the current node. + * u - The previous node. + * @param directed [optional] A boolean indicating whether the search should only go along edges from source to target (default false). + */ + dfs(roots: Selector|Collection, + visit?: (i: number, depth: number, v: CollectionNodes, e: CollectionEdges, u: CollectionNodes) => boolean, + directed?: boolean): SearchBreadthFirstResult; + + /** + * Perform Dijkstra's algorithm on the elements in the collection. This finds the shortest paths to all other nodes in the collection from the root node. + * + * Note that this function performs Dijkstra's algorithm on only the subset of the graph in the calling collection. + */ + dijkstra(options: SearchDijkstraOptions): SearchDijkstraResult; + /** + * Perform Dijkstra's algorithm on the elements in the collection. This finds the shortest paths to all other nodes in the collection from the root node. + * + * Note that this function performs Dijkstra's algorithm on only the subset of the graph in the calling collection. + * + * @param root The root node (selector or collection) where the algorithm starts. + * @param weight [optional] A function that returns the positive numeric weight for this edge. + * If no weight function is defined, a constant weight of 1 is used for each edge. + * @param directed [optional] A boolean indicating whether the algorithm should only go along edges from source to target (default false). + */ + dijkstra(root: Selector|Collection, + weight?: (edge: CollectionEdges) => number, + directed?: boolean): SearchDijkstraResult; + + + //TODO: continue here: http://js.cytoscape.org/#collection/algorithms/eles.dijkstra + } + interface CollectionNodesCompound { + // http://js.cytoscape.org/#collection/compound-nodes + + /** + * Get the compound parent node of each node in the collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + parent(selector?: Selector): CollectionNodes; + + /** + * Get all compound ancestor nodes (i.e. parents, parents' parents, etc.) of each node in the collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + parents(selector?: Selector): CollectionNodes; + /** + * Get all compound ancestor nodes (i.e. parents, parents' parents, etc.) of each node in the collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + ancestors(selector?: Selector): CollectionNodes; + + /** + * Get all compound ancestors common to all the nodes in the collection, starting with the closest and getting progressively farther. + * + * You can get the closest common ancestor via + * nodes.commonAncestors().first() + * and the farthest via + * nodes.commonAncestors().last() + * , because the common ancestors are in descending order of closeness. + * + * @param selector [optional] A selector used to filter the resultant collection + */ + commonAncestors(selector?: Selector): CollectionNodes; + + /** + * Get all orphan (i.e. has no compound parent) nodes in the calling collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + orphans(selector?: Selector): CollectionNodes; + + /** + * Get all nonorphan (i.e. has a compound parent) nodes in the calling collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + nonorphans(selector?: Selector): CollectionNodes; + + /** + * Get all compound child (i.e. direct descendant) nodes of each node in the collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + children(selector?: Selector): CollectionNodes; + + /** + * Get all compound descendant (i.e. children, children's children, etc.) nodes of each node in the collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + descendants(selector?: Selector): CollectionNodes; + + /** + * Get all sibling (i.e. same compound parent) nodes of each node in the collection. + * + * @param selector [optional] A selector used to filter the resultant collection. + */ + siblings(selector?: Selector): CollectionNodes; + } + + interface CollectionFirstManipulation { + /** + * Get whether the element has been removed from the graph. + */ + removed(): boolean; + /** + * Get whether the element is inside the graph (i.e. not removed). + */ + inside(): boolean; + + } + interface CollectionFirstData { + //http://js.cytoscape.org/#collection/data + + /** + * Get all data for the element. + */ + data(): any; + /** + * Get a particular data field for the element. + */ + data(name: string): any; + /** + * Set a particular data field for the element. + */ + data(name: string, value: any); + /** + * Update multiple data fields at once via an object. + */ + data(obj: any); + + /** + * Get the entire scratchpad object for the element, where temporary or non-JSON data can be stored. App-level scratchpad data should use namespaces prefixed with underscore, like '_foo'. + */ + scratch(): Scratchpad; + /** + * Get the scratchpad at a particular namespace, where temporary or non-JSON data can be stored. App-level scratchpad data should use namespaces prefixed with underscore, like '_foo'. + * + * @param namespace A namespace string. + */ + scratch(namespace: string): Scratchpad; + /** + * Set the scratchpad at a particular namespace, where temporary or non-JSON data can be stored. App-level scratchpad data should use namespaces prefixed with underscore, like '_foo'. + * + * @param namespace A namespace string. + * @param value The value to set at the specified namespace. + */ + scratch(namespace: string, value: any): Scratchpad; + + /** + * Remove scratchpad data. You should remove scratchpad data only at your own namespaces. + * + * @param namespace A namespace string. + */ + removeScratch(namespace: string); + + /** + * A shortcut to get the ID of an element. + */ + id(): string; + + /** + * Get the element's plain JavaScript object representation. + */ + json(): string; + + /** + * Get the group string that defines the type of the element. + * + * The group strings are 'nodes' for nodes and 'edges' for edges. In general, you should be using ele.isEdge() and ele.isNode() instead of ele.group(). + */ + group(): ElementGroup; + + /** + * Get whether the element is a node. + */ + isNode(): boolean; + + /** + * Get whether the element is an edge. + */ + isEdge(): boolean; + + + cy(): Cy.Instance + } + interface CollectionFirstEdgeData { + //http://js.cytoscape.org/#collection/data + + /** + * Get whether the edge is a loop (i.e. source same as target). + */ + isLoop(): boolean; + + /** + * Get whether the edge is simple (i.e. source different than target). + */ + isSimple(): boolean; + } + interface CollectionFirstNodeMetadata { + //http://js.cytoscape.org/#collection/metadata + + /** + * Get the degree of a node. + * + * For a node, the degree is the number of edge connections it has. Each time a node is referenced as source or target of an edge in the graph, that counts as an edge connection. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + degree(includeLoops: boolean): number; + /** + * Get the indegree of a node. + * + * For a node, the indegree is the number of incoming edge connections it has. Each time a node is referred to as target of an edge in the graph, that counts as an incoming edge connection. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + indegree(includeLoops: boolean): number; + /*** + * Get the outdegree of a node. + * + * For a node, the outdegree is the number of outgoing edge connections it has. Each time a node is referred to as source of an edge in the graph, that counts as an outgoing edge connection. + * + * @param includeLoops A boolean, indicating whether loops are to be included in degree calculations. + */ + outdegree(includeLoops: boolean): number; + } + interface CollectionFirstNodePosition extends CollectionPosition{ + //http://js.cytoscape.org/#collection/position--dimensions + + /** + * Get the (model) position of a node. + */ + position(): Position; + /** + * Get the value of a specified position dimension. + * + * @param dimension The position dimension to get. + */ + position(dimension: PositionDimension): Position; + /** + * Set the value of a specified position dimension. + * + * @param dimension The position dimension to set. + * @param value The value to set to the dimension. + */ + position(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + position(pos: Position): CollectionNodes; + + /** + * Get the (model) position of a node. + */ + modelPosition(): Position; + /** + * Get the value of a specified position dimension. + * + * @param dimension The position dimension to get. + */ + modelPosition(dimension: PositionDimension): Position; + /** + * Set the value of a specified position dimension. + * + * @param dimension The position dimension to set. + * @param value The value to set to the dimension. + */ + modelPosition(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + modelPosition(pos: Position): CollectionNodes; + + /** + * Get the (model) position of a node. + */ + point(): Position; + /** + * Get the value of a specified position dimension. + * + * @param dimension The position dimension to get. + */ + point(dimension: PositionDimension): Position; + /** + * Set the value of a specified position dimension. + * + * @param dimension The position dimension to set. + * @param value The value to set to the dimension. + */ + point(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + point(pos: Position): CollectionNodes; + + /** + * Get the rendered (on-screen) position of a node. + */ + renderedPosition(): Position; + /** + * Get the value of a specified rendered posisition dimension. + * + * @param dimension The position dimension to get. + */ + renderedPosition(dimension: PositionDimension): number; + /** + * Set the value of a specified rendered posisition dimension. + * + * @param dimension The position dimension to get. + * @param value The value to set to the dimension. + */ + renderedPosition(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the rendered position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + renderedPosition(pos: Position): CollectionNodes; + + /** + * Get the rendered (on-screen) position of a node. + */ + renderedPoint(): Position; + /** + * Get the rendered (on-screen) position of a node. + * + * @param dimension The position dimension to get. + */ + renderedPoint(dimension: PositionDimension): number; + /** + * Set the value of a specified rendered posisition dimension. + * + * @param dimension The position dimension to get. + * @param value The value to set to the dimension. + */ + renderedPoint(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the rendered position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + renderedPoint(pos: Position): CollectionNodes; + + /** + * Get the position of a node, relative to its compound parent. + */ + relativePosition(): Position; + /** + * Get the position of a node, relative to its compound parent. + * + * @param dimension The position dimension to get. + */ + relativePosition(dimension: PositionDimension): number; + /** + * Set the value of a specified relative posisition dimension. + * + * @param dimension The position dimension to get. + * @param value The value to set to the dimension. + */ + relativePosition(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the relative position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + relativePosition(pos: Position): CollectionNodes; + + /** + * Get the position of a node, relative to its compound parent. + */ + relativePoint(): Position; + /** + * Get the position of a node, relative to its compound parent. + * + * @param dimension The position dimension to get. + */ + relativePoint(dimension: PositionDimension): number; + /** + * Set the value of a specified relative posisition dimension. + * + * @param dimension The position dimension to get. + * @param value The value to set to the dimension. + */ + relativePoint(dimension: PositionDimension, value: number): CollectionNodes; + /** + * Set the relative position using name-value pairs in the specified object. + * + * @param pos An object specifying name-value pairs representing dimensions to set. + */ + relativePoint(pos: Position): CollectionNodes; + } + interface CollectionFirstPosition { + //http://js.cytoscape.org/#collection/position--dimensions + + /** + * Get the width of the element. + */ + width(): number; + /** + * Get the outer width of the element (includes width & border). + */ + outerWidth(): number; + /** + * Get the width of the element in rendered dimensions. + */ + renderedWidth(): number; + /** + * Get the outer width of the element (includes width & border) in rendered dimensions. + */ + renderedOuterWidth(): number; + + /** + * Get the height of the element. + */ + height(): number; + /** + * Get the outer height of the element (includes height & border). + */ + outerHeight(): number; + /** + * Get the height of the element in rendered dimensions. + */ + renderedHeight(): number; + /** + * Get the outer height of the element (includes height & border) in rendered dimensions. + */ + renderedOuterHeight(): number; + + /** + * Gets whether the element is active (e.g. on user tap, grab, etc). + */ + active(): boolean; + } + interface CollectionFirstSelection { + // http://js.cytoscape.org/#collection/selection + + /** + * Get whether the element is selected. + */ + selected(): boolean; + + /** + * Get whether the element's selection state is mutable. + */ + selectable(): boolean; + } + interface CollectionFirstStyle { + // http://js.cytoscape.org/#collection/style + + /** + * Get whether an element has a particular class. + * + * @param className The name of the class to test for. + */ + hasClass(className: string): boolean; + + ///** + //* Get a name-value pair object containing visual style properties and their values for the element. + //*/ + //style(): Css.ElementCss; + ///** + // * Get a particular style property value. + // * + // * @param name The name of the visual style property to get. + // */ + //style(name: string): Css.ElementCss; + + ///** + // * Get a name-value pair object containing visual style properties and their values for the element. + // */ + //css(): Css.ElementCss; + ///** + // * Get a particular style property value. + // * + // * @param name The name of the visual style property to get. + // */ + //css(name: string): Css.ElementCss; + + ///** + // * Get a name-value pair object containing visual style properties and their values for the element. + // */ + //bypass(): Css.ElementCss; + ///** + // * Get a particular style property value. + // * + // * @param name The name of the visual style property to get. + // */ + //bypass(name: string): Css.ElementCss; + + /** + * Get a name-value pair object containing rendered visual style properties and their values for the element. + */ + renderedStyle(): Css.ElementCss; + /** + * Get a particular rendered style property value. + * + * @param name The name of the visual style property to get. + */ + renderedStyle(name: string): Css.ElementCss; + /** + * Get a name-value pair object containing rendered visual style properties and their values for the element. + */ + renderedCss(): Css.ElementCss; + /** + * Get a particular rendered style property value. + * + * @param name The name of the visual style property to get. + */ + renderedCss(name: string): Css.ElementCss; + + /** + * Get whether the element is visible. + */ + visible(): boolean; + /** + * Get whether the element is hidden. + */ + hidden(): boolean; + + /** + * Get the effective opacity of the element (i.e. on-screen opacity), which takes into consideration parent node opacity. + */ + effectiveOpacity(): number; + + /** + * Get whether the element's effective opacity is completely transparent, which takes into consideration parent node opacity. + */ + transparent(): boolean; + } + interface CollectionFirtsAnimation { + // http://js.cytoscape.org/#collection/animation + + /** + * Get whether the element is currently being animated. + */ + animated(): boolean; + } + interface CollectionFirstEdgeTraversing { + // http://js.cytoscape.org/#collection/traversing + + /** + * Get source node of this edge. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + source(selector?: Selector): CollectionNodes; + + /** + * Get target node of this edge. + * + * @param selector [optional] An optional selector that is used to filter the resultant collection. + */ + target(selector?: Selector): CollectionNodes; + } + interface CollectionFirstNodeCompound { + // http://js.cytoscape.org/#collection/compound-nodes + + /** + * Get whether the node is a compound parent (i.e. a node containing one or more child nodes) + */ + isParent(): boolean; + + /** + * Get whether the node is a compound child (i.e. contained within a node) + */ + isChild(): boolean; + } + + interface ElementsDefinition { + nodes: Sdc.Models.Graph.CommonNodeBase[]; + edges: Sdc.Models.CommonLinkBase[]; + } + + interface ElementDefinition { + + + group?: ElementGroup; + data: Sdc.Models.Graph.CommonNodeBase| Sdc.Models.CommonLinkBase; + /** + * Scratchpad data (usually temp or nonserialisable data) + */ + scatch?: Scratchpad; + /** + * The model position of the node (optional on init, mandatory after) + */ + position?: Position; + /** + * can alternatively specify position in rendered on-screen pixels + */ + renderedPosition?: Position; + /** + * Whether the element is selected (default false) + */ + selected?: boolean; + /** + * Whether the selection state is mutable (default true) + */ + selectable?: boolean; + /** + * When locked a node's position is immutable (default false) + */ + locked?: boolean; + /** + * Wether the node can be grabbed and moved by the user + */ + grabbable?: boolean; + /** + * a space separated list of class names that the element has + */ + classes?: string; + style?: CSSStyleDeclaration; + /** + * you should only use `style`/`css` for very special cases; use classes instead + */ + css?: Css.ElementCss; + } + + // interface ElementDataDefinition { + // /** + // * elided id => autogenerated id + // */ + // isSdcElement?: boolean; + // id?: string; + // position?: Position; + // label?: string; + // } + interface EdgeDefinition extends ElementDefinition { + data: Sdc.Models.CommonLinkBase; + } + + // interface EdgeDataDefinition extends ElementDataDefinition { /** + // * the source node id (edge comes from this node) + // */ + // source: string; + // /** + // * the target node id (edge goes to this node) + // */ + // target: string; + // commonGraphLink?: Sdc.Models.CompositionCiLinkBase; //this is sdc-link-data-object + // } + interface NodeDefinition extends ElementDefinition { + + data: Sdc.Models.Graph.CommonNodeBase; + + } + // interface NodeDataDefinition extends ElementDataDefinition { + // parent?: string; + // commonGraphNode?: Sdc.Models.Graph.CommonNodeBase; //this is sdc-node-data-object + // type: string + // + // } + + interface Stylesheet { + selector: string; + css: Css.ElementCss; + } + + export module Css { + //TODO: http://js.cytoscape.org/#style + + type Colour = string; + + // TODO: How to constrain to a value? + type Shape = string; // 'rectangle', 'roundrectangle', 'ellipse', 'triangle', pentagon, hexagon, heptagon, octagon, star + + // TODO: How to constrain to a value? + type Style = string; // solid, dotted, dashed, or double + + export interface NodeCss { + width?: number; + height?: number; + shape?: Shape; + backgroundColor?: Colour; + "background-color"?: any; + "background-blacken"?: number; + "background-opacity"?: number; + "background-image"?: any; + "background-width"?: number; + "background-height"?: number; + "border-width"?: number; + "border-style"?: Style; + "border-color"?: Colour; + "border-opacity"?: number; + "label"?: string; + "events"?: string; + "text-events"?: string; + "text-valign"? :string; + "text-halign"? :string; + "text-margin-y"? :any; + "active-bg-size"?: number; + "background-fit"?: string; + "background-clip"?: string; + "background-image-opacity"?: number; + "overlay-color"?: string; + "font-size"? :number; + "font-family"? :string; + "background-position-x"? :number; + "background-position-y"? :number; + 'overlay-opacity'?: number; + 'text-border-width'?: number; + 'text-border-color'?: string; + 'text-border-opacity'?: number; + } + + export interface SelectionBox { + "selection-box-color"?: string + "selection-box-border-color"?: string + "selection-box-border-width"?: number + "selection-box-opacity"?: number + + } + + export interface CompoundNodeCss extends NodeCss { + "padding-left"?: number; + "padding-right"?: number; + "padding-top"?: number; + "padding-bottom"?: number; + "compound-sizing-wrt-labels"?: string; + } + + export interface EdgeCss { + + "line-color"?: string; + "target-arrow-color"?: string; + "target-arrow-shape"?: string; + "curve-style"?: string; + "control-point-step-size"?: number; + "control-point-distances"?: string, + "control-point-weights"?: string, + "segment-distances"?: string, + "segment-weights"?: string + "line-style"? : string + } + + export interface ElementCss extends NodeCss, CompoundNodeCss, EdgeCss, SelectionBox { + } + //export interface ElementCss extends CSSStyleDeclaration { } + } + + interface Renderer { + /** + * The name of the renderer to use. By default, the 'canvas' renderer is used. If you build and register your own renderer, then you can specify its name here. + */ + name: string; + } + + interface Instance extends InstanceEvent, InstanceViewPort, InstanceAnimation, InstanceLayout, InstanceStyle, InstanceExport { + /** + * Add elements to the graph and return them. + */ + add(eleObj: ElementDefinition): CollectionElements; + /** + * Add elements to the graph and return them. + */ + add(eleObjs: ElementDefinition[]): CollectionElements; + /** + * Add elements to the graph and return them. + */ + add(eles: Collection): CollectionElements; + + /** + * Remove elements from the graph and return them. + */ + remove(eles: Collection): CollectionElements; + /** + * Remove elements in the graph matching the specified selector. + */ + remove(selector: Selector): CollectionElements; + + /** + * Get an empty collection. + */ + collection(): CollectionElements; + /** + * Get a collection from elements in the graph matching the specified selector. + */ + collection(selector: Selector): CollectionElements; + /** + * Get a collection from an array of elements. + */ + collection(elesArray: CollectionElements[]): CollectionElements; + + /** + * Get an element from its ID in a very performant way. + */ + getElementById(id: string): CollectionElements; + + /** + * Get elements in the graph matching the specified selector. + */ + $(selector: Selector): CollectionElements; + /** + * Get elements in the graph. + */ + elements(): CollectionElements; + /** + * Get elements in the graph matching the specified selector. + */ + elements(selector: Selector): CollectionElements; + /** + * Get nodes in the graph. + */ + nodes(): CollectionNodes; + /** + * Get nodes in the graph matching the specified selector. + */ + nodes(selector: Selector): CollectionNodes; + /** + * Get edges in the graph. + */ + edges(): CollectionEdges; + /** + * Get edges in the graph matching the specified selector. + */ + edges(selector: Selector): CollectionEdges; + /** + * Get elements in the graph matching the specified selector. + */ + filter(selector: Selector): CollectionElements; + /** + * Get elements in the graph matching the specified filter function. + */ + filter(filter: (i: number, ele: CollectionFirst) => boolean): CollectionElements; + + /** + * Allow for manipulation of elements without triggering multiple style calculations or multiple redraws. + * + * A callback within which you can make batch updates to elements. + */ + batch(callback: () => void): void; + /** + * Allow for manipulation of elements without triggering multiple style calculations or multiple redraws. + * Starts batching manually (useful for asynchronous cases). + */ + startBatch(): void; + /** + * Allow for manipulation of elements without triggering multiple style calculations or multiple redraws. + * Ends batching manually (useful for asynchronous cases). + */ + endBatch(): void; + + /** + * A convenience function to explicitly destroy the instance. + */ + destroy(): void; + } + + interface EventObject { + /** + * Holds a reference to the originator of the event (core or element) + */ + cyTarget: any; //CollectionElements or Cy.Instance; + data: any; + } + + interface InstanceEvent { + // http://js.cytoscape.org/#core/events + + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + */ + on(events: string, handler: (evt: EventObject, data?: any) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + */ + on(events: string, selector: Selector, handler: (evt: EventObject, data?: any) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + on(events: string, selector: Selector, data: any, handler: (evt: EventObject, data?: any) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param eventsMap A map of event names to handler functions. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + on(eventsMap: { + [value: string]: (evt: EventObject, data?: any) => void + }, selector?: Selector, data?: any); + + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + */ + bind(events: string, handler: (evt: EventObject, data?: any) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + */ + bind(events: string, selector: Selector, handler: (evt: EventObject, data?: any) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + bind(events: string, selector: Selector, data: any, handler: (evt: EventObject, data?: any) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param eventsMap A map of event names to handler functions. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + bind(eventsMap: { + [value: string]: (evt: EventObject, data?: any) => void + }, selector?: Selector, data?: any); + + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + */ + listen(events: string, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + */ + listen(events: string, selector: Selector, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + listen(events: string, selector: Selector, data: any, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param eventsMap A map of event names to handler functions. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + listen(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector, data?: any); + + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + */ + addListener(events: string, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + */ + addListener(events: string, selector: Selector, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + addListener(events: string, selector: Selector, data: any, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph. + * + * @param eventsMap A map of event names to handler functions. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + addListener(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector, data?: any); + + /** + * Bind to events that occur in the graph, and trigger the handler only once. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + */ + one(events: string, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph, and trigger the handler only once. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + */ + one(events: string, selector: Selector, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph, and trigger the handler only once. + * + * @param events A space separated list of event names. + * @param handler The handler function that is called when one of the specified events occurs. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + one(events: string, selector: Selector, data: any, handler: (evt: EventObject) => void): void; + /** + * Bind to events that occur in the graph, and trigger the handler only once. + * + * @param eventsMap A map of event names to handler functions. + * @param selector A selector to specify elements for which the handler is triggered. + * @param data A plain object which is passed to the handler in the event object argument. + */ + one(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector, data?: any); + + /** + * Remove event handlers. + * @param events A space separated list of event names. + * @param selector [optional] The same selector used to bind to the events. + * @param handler [optional] A reference to the handler function to remove. + */ + off(events: string, selector?: Selector, handler?: (evt: EventObject) => void): void; + + /** + * Remove event handlers. + * @param eventsMap A map of event names to handler functions to remove. + * @param selector [optional] The same selector used to bind to the events. + */ + off(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector): void; + + /** + * Remove event handlers. + * @param events A space separated list of event names. + * @param selector [optional] The same selector used to bind to the events. + * @param handler [optional] A reference to the handler function to remove. + */ + unbind(events: string, selector?: Selector, handler?: (evt: EventObject) => void): void; + + /** + * Remove event handlers. + * @param eventsMap A map of event names to handler functions to remove. + * @param selector [optional] The same selector used to bind to the events. + */ + unbind(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector): void; + + /** + * Remove event handlers. + * @param events A space separated list of event names. + * @param selector [optional] The same selector used to bind to the events. + * @param handler [optional] A reference to the handler function to remove. + */ + unlisten(events: string, selector?: Selector, handler?: (evt: EventObject) => void): void; + + /** + * Remove event handlers. + * @param eventsMap A map of event names to handler functions to remove. + * @param selector [optional] The same selector used to bind to the events. + */ + unlisten(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector): void; + + /** + * Remove event handlers. + * @param events A space separated list of event names. + * @param selector [optional] The same selector used to bind to the events. + * @param handler [optional] A reference to the handler function to remove. + */ + removeListener(events: string, selector?: Selector, handler?: (evt: EventObject) => void): void; + + /** + * Remove event handlers. + * + * @param eventsMap A map of event names to handler functions to remove. + * @param selector [optional] The same selector used to bind to the events. + */ + removeListener(eventsMap: { + [value: string]: (evt: EventObject) => void + }, selector?: Selector): void; + + /** + * Trigger one or more events. + * + * @param events A space separated list of event names to trigger. + * @param extraParams [optional] An array of additional parameters to pass to the handler. + */ + trigger(events: string, extraParams?: any[]): void; + + /** + * Trigger one or more events. + * + * @param events A space separated list of event names to trigger. + * @param extraParams [optional] An array of additional parameters to pass to the handler. + */ + emit(events: string, extraParams?: any[]): void; + + /** + * Get whether the initial render event has occurred (useful for plugins etc). + * + * This function returns whether the initrender event has occurred on the graph, meaning that the renderer has drawn the graph at least once. This is useful when you need to grab image data from the core, as this function will let you know whether that data is available yet: You can not grab the graph scene if it has not yet been rendered. + */ + initrender(): boolean; + + /** + * Run a handler function every time a frame is rendered. + * + * @param handler The handler function to call on each frame. + */ + onRender(handler: () => void): void; + + /** + * Remove handlers function bound via cy.onRender(). + * + * @param handler [optional] A reference to the handler function to remove. All handlers are removed if this is unspecified. + */ + offRender(handler?: () => void): void; + + /** + * Run a callback as soon as the graph becomes ready. If the graph is already ready, then the callback is called immediately. + * @param fn The callback run as soon as the graph is ready, inside which this refers to the core (cy). + */ + ready(fn: () => void): void; + } + + interface InstanceViewPort { + // http://js.cytoscape.org/#core/viewport-manipulation + + /** + * Pan the graph to the centre of a collection. + * + * @param eles The collection to centre upon. + */ + center(eles?: Collection): CollectionElements; + + /** + * Pan and zooms the graph to fit to a collection. + * + * @param eles [optional] The collection to fit to. + * @param padding [optional] An amount of padding (in pixels) to have around the graph + */ + fit(eles?: Collection, padding?: number): CollectionElements; + + /** + * Reset the graph to the default zoom level and panning position. + */ + reset(): CollectionElements; + + /** + * Get the panning position of the graph. + */ + pan(): Position; + + /** + * Set the panning position of the graph. + * + * @param renderedPosition The rendered position to pan the graph to. + */ + pan(renderedPosition?: Position): void; + + /** + * Relatively pan the graph by a specified rendered position vector. + * + * @param renderedPosition The rendered position vector to pan the graph by. + */ + panBy(renderedPosition: Position): void; + + /** + * Get whether panning is enabled. If cy.boxSelectionEnabled() === true, then the user must taphold to initiate panning. + */ + panningEnabled(): boolean; + + /** + * Set whether panning is enabled. If cy.boxSelectionEnabled() === true, then the user must taphold to initiate panning. + * + * @param bool A truthy value enables panning; a falsey value disables it. + */ + panningEnabled(bool: boolean): void; + + /** + * Get whether panning by user events (e.g. dragging the graph background) is enabled. If cy.boxSelectionEnabled() === true, then the user must taphold to initiate panning. + */ + userPanningEnabled(): boolean; + + /** + * Set whether panning by user events (e.g. dragging the graph background) is enabled. If cy.boxSelectionEnabled() === true, then the user must taphold to initiate panning. + * + * @param bool A truthy value enables user panning; a falsey value disables it. + */ + userPanningEnabled(bool: boolean): void; + + /** + * Get the zoom level. + */ + zoom(): number; + /** + * Set the zoom level. + * + * @param level The zoom level to set. + */ + zoom(level: number): void; + /** + * Set the zoom level. + * + * @param options The options for zooming. + */ + zoom(options: ZoomOptions): void; + + /** + * Get whether zooming is enabled. + */ + zoomingEnabled(): boolean; + /** + * Set whether zooming is enabled. + * + * @param bool A truthy value enables zooming; a falsey value disables it. + */ + zoomingEnabled(bool: boolean): void; + + /** + * Get whether zooming by user events (e.g. mouse wheel, pinch-to-zoom) is enabled. + */ + userZoomingEnabled(): boolean; + /** + * Set whether zooming by user events (e.g. mouse wheel, pinch-to-zoom) is enabled. + * + * @param bool A truthy value enables user zooming; a falsey value disables it. + */ + userZoomingEnabled(bool: boolean): void; + + /** + * Get the minimum zoom level. + */ + minZoom(): number; + /** + * Set the minimum zoom level. + * + * @param zoom The new minimum zoom level to use. + */ + minZoom(zoom: number): void; + + /** + * Get the maximum zoom level. + */ + maxZoom(): number; + /** + * Set the maximum zoom level. + * + * @param zoom The new maximum zoom level to use. + */ + maxZoom(zoom: number): void; + + /** + * Set the viewport state (pan & zoom) in one call. + * + * @param zoom The zoom level to set. + * @param pan The pan to set (a rendered position). + */ + viewport(zoom: number, pan: Position): void; + + /** + * Get whether box selection is enabled. If enabled, the user must hold left-click to initiate panning. + */ + boxSelectionEnabled(): boolean; + /** + * Set whether box selection is enabled. If enabled, the user must hold left-click to initiate panning. + * + * @param bool A truthy value enables box selection; a falsey value disables it. + */ + boxSelectionEnabled(bool: boolean): void; + + /** + * Get the on-screen width of the viewport in pixels. + */ + width(): number; + + /** + * Get the on-screen height of the viewport in pixels. + */ + height(): number; + + /** + * Get the extent of the viewport, a bounding box in model coordinates that lets you know what model positions are visible in the viewport. + */ + extent(): Extent; + + /** + * Get whether nodes are automatically locked (i.e. if true, nodes are locked despite their individual state). + */ + autolock(): boolean; + /** + * Set whether nodes are automatically locked (i.e. if true, nodes are locked despite their individual state). + * + * @param bool A truthy value enables autolocking; a falsey value disables it. + */ + autolock(bool: boolean): void; + + /** + * Get whether nodes are automatically ungrabified (i.e. if true, nodes are ungrabbale despite their individual state). + */ + autoungrabify(): boolean; + /** + * Set whether nodes are automatically ungrabified (i.e. if true, nodes are ungrabbale despite their individual state). + * + * @param bool A truthy value enables autolocking; a falsey value disables it. + */ + autoungrabify(bool: boolean): void; + + /** + * Get whether nodes are automatically unselectified (i.e. if true, nodes are unselectable despite their individual state). + */ + autounselectify(): boolean; + /** + * Set whether nodes are automatically unselectified (i.e. if true, nodes are unselectable despite their individual state). + * + * @param bool A truthy value enables autolocking; a falsey value disables it. + */ + autounselectify(bool: boolean): void; + + /** + * Force the renderer to redraw (i.e. draw a new frame). + * + * This function forces the renderer to draw a new frame. It is useful for very specific edgecases, such as in certain UI plugins, but it should not be needed for most developers. + */ + forceRender(): void; + + /** + * Force the renderer to recalculate the viewport bounds. + * + * If your code resizes the graph's dimensions or position (i.e. by changing the style of the HTML DOM element that holds the graph), you will want to call cy.resize() to have the graph resize and redraw itself. + * + * Cytoscape.js can not automatically monitor the bounding box of the viewport, as querying the DOM for those dimensions can be expensive. Although cy.resize() is automatically called for you on the window's resize event, there is no resize or style event for arbitrary DOM elements. + */ + resize(): CollectionElements; + } + + interface InstanceAnimation { + // http://js.cytoscape.org/#core/animation + + /** + * Get whether the viewport is currently being animated. + */ + animated(): boolean; + + /** + * Animate the viewport. + * + * @param anis An object containing the details of the animation. + * zoom A zoom level to which the graph will be animated. + * pan A panning position to which the graph will be animated. + * panBy A relative panning position to which the graph will be animated. + * fit An object containing fitting options from which the graph will be animated. + * eles Elements or a selector to which the viewport will be fitted. + * padding Padding to use with the fitting. + * center An object containing centring options from which the graph will be animated. + * eles Elements or a selector to which the viewport will be centred. + * @param options An object containing animation options. + * duration - The duration of the animation in milliseconds. + * queue - A boolean indicating whether to queue the animation. + * complete - A function to call when the animation is done. + * step - A function to call each time the animation steps. + */ + animate(anis: { + zoom?: number, + pan?: Position, + panBy?: Position, + fit?: { + eles: Collection, + padding?: number + }, + center?: { + eles: Collection + } + }, options?: { + duration?: number, + queue?: boolean, + complete?: () => void, + step?: () => void + }): Cy.Instance; + + /** + * Add a delay between animations for the viewport. + * + * @param duration How long the delay should be in milliseconds. + * @param complete A function to call when the delay is complete. + */ + delay(duration: number, complete?: () => void): Cy.Instance; + + /** + * Stop all viewport animations that are currently running. + * + * @param clearQueue A boolean, indicating whether the queue of animations should be emptied. + * @param jumpToEnd A boolean, indicating whether the currently-running animations should jump to their ends rather than just stopping midway. + */ + stop(clearQueue?: boolean, jumpToEnd?: boolean): Cy.Instance; + + /** + * Remove all queued animations for the viewport. + */ + clearQueue(): Cy.Instance; + } + + interface InstanceLayout { + //TODO: http://js.cytoscape.org/#core/layout + layout(layout: LayoutOptions): void; + + } + + interface InstanceStyle { + //TODO: http://js.cytoscape.org/#core/style + } + + interface InstanceExport { + /** + * Export the current graph view as a PNG image in Base64 representation. + */ + png(): string; + /** + * Export the current graph view as a PNG image in Base64 representation. + */ + png(options: ExportOptions): string; + + /** + * Export the current graph view as a JPG image in Base64 representation. + */ + jpg(): string; + /** + * Export the current graph view as a JPG image in Base64 representation. + */ + jpg(options: ExportOptions): string; + + /** + * Export the current graph view as a JPG image in Base64 representation. + */ + jpeg(): string; + /** + * Export the current graph view as a JPG image in Base64 representation. + */ + jpeg(options: ExportOptions): string; + + /** + * Export the graph as JSON, the same format used at initialisation. + */ + json(): string; + } + + interface Position { + x: number; + y: number; + } + + interface LayoutInstance { + //TODO: http://js.cytoscape.org/#layouts/layout-manipulation + + /** + * Start running the layout. + */ + run(): void; + /** + * Start running the layout. + */ + start(): void; + + /** + * Stop running the (asynchronous/discrete) layout. + */ + stop(): void; + } + + interface LayoutOptions { + // TODO: http://js.cytoscape.org/#layouts + /** + * + * The default is 'grid'. + */ + name?: string; + padding?: number; + avoidOverlap?: boolean; + } + + interface CytoscapeOptions { + // very commonly used options: + /** + * A HTML DOM element in which the graph should be rendered. + * This is optional if Cytoscape.js is run headlessly or if you initialise using jQuery (in which case your jQuery object already has an associated DOM element). + * + * The default is undefined. + */ + container?: HTMLElement | JQuery; + /** + * The [[Stylesheet]] used to style the graph. For convenience, this option can alternatively be specified as a promise that resolves to the stylesheet. + */ + style?: Stylesheet[]|Promise<Stylesheet[]>; + /** + * An array of [[Elements]] specified as plain objects. For convenience, this option can alternatively be specified as a promise that resolves to the elements JSON. + */ + elements?: ElementsDefinition|ElementDefinition[]|Promise<ElementsDefinition>|Promise<ElementDefinition[]>; + /** + * A plain object that specifies layout options. Which layout is initially run is specified by the name field. Refer to a layout's documentation for the options it supports. If you want to specify your node positions yourself in your elements JSON, you can use the preset layout — by default it does not set any positions, leaving your nodes in their current positions (e.g. specified in options.elements at initialisation time) + */ + layout?: LayoutOptions; + /** + * A callback function that is called when Cytoscape.js has loaded the graph and the layout has specified initial positions of the nodes. After this point, rendering can happen, the user can interact with the graph, et cetera. + */ + ready?: (evt: any) => void; + + // initial viewport state: + /** + * The initial zoom level of the graph. Make sure to disable viewport manipulation options, such as fit, in your layout so that it is not overridden when the layout is applied. You can set options.minZoom and options.maxZoom to set restrictions on the zoom level. + * + * The default value is 1. + */ + zoom?: number; + /** + * The initial panning position of the graph. Make sure to disable viewport manipulation options, such as fit, in your layout so that it is not overridden when the layout is applied. + */ + pan?: Position; + + // interaction options?: + /** + * A minimum bound on the zoom level of the graph. The viewport can not be scaled smaller than this zoom level. + * + * The default value is 1e-50. + */ + minZoom?: number; + /** + * A maximum bound on the zoom level of the graph. The viewport can not be scaled larger than this zoom level. + * + * The default value is 1e50. + */ + maxZoom?: number; + /** + * Whether zooming the graph is enabled, both by user events and programmatically. + * + * The default value is true. + */ + zoomingEnabled?: boolean; + /** + * Whether user events (e.g. mouse wheel, pinch-to-zoom) are allowed to zoom the graph. Programmatic changes to zoom are unaffected by this option. + * + * The default value is true. + */ + userZoomingEnabled?: boolean; + /** + * Whether panning the graph is enabled, both by user events and programmatically. + * + * The default value is true. + */ + panningEnabled?: boolean; + /** + * Whether user events (e.g. dragging the graph background) are allowed to pan the graph. Programmatic changes to pan are unaffected by this option. + * + * The default value is true. + */ + userPanningEnabled?: boolean; + /** + * Whether box selection (i.e. drag a box overlay around, and release it to select) is enabled. If enabled, the user must taphold to pan the graph. + * + * The default value is false. + */ + boxSelectionEnabled?: boolean; + /** + * A string indicating the selection behaviour from user input. By default, this is set automatically for you based on the type of input device detected. On touch devices, 'additive' is default — a new selection made by the user adds to the set of currenly selected elements. On mouse-input devices, 'single' is default — a new selection made by the user becomes the entire set of currently selected elements (i.e. the previous elements are unselected). + * + * The default value is (isTouchDevice ? 'additive' : 'single'). + */ + selectionType?: SelectionType; + /** + * A nonnegative integer that indicates the maximum allowable distance that a user may move during a tap gesture, on touch devices and desktop devices respectively. This makes tapping easier for users. These values have sane defaults, so it is not advised to change these options unless you have very good reason for doing so. Larger values will almost certainly have undesirable consequences. + * + * The default value is is 8. + */ + touchTapThreshold?: number; + /** + * A nonnegative integer that indicates the maximum allowable distance that a user may move during a tap gesture, on touch devices and desktop devices respectively. This makes tapping easier for users. These values have sane defaults, so it is not advised to change these options unless you have very good reason for doing so. Larger values will almost certainly have undesirable consequences. + * + * The default value is 4. + */ + desktopTapThreshold?: number; + /** + * Whether nodes should be locked (not draggable at all) by default (if true, overrides individual node state). + * + * The default value is false. + */ + autolock?: boolean; + /** + * Whether nodes should be ungrabified (not grabbable by user) by default (if true, overrides individual node state). + * + * The default value is false. + */ + autoungrabify?: boolean; + /** + * Whether nodes should be unselectified (immutable selection state) by default (if true, overrides individual element state). + * + * The default value is false. + */ + autounselectify?: boolean; + + // rendering options: + /** + * A convenience option that initialises the instance to run headlessly. You do not need to set this in environments that are implicitly headless (e.g. Node.js). However, it is handy to set headless: true if you want a headless instance in a browser. + * + * The default value is false. + */ + headless?: boolean; + /** + * A boolean that indicates whether styling should be used. For headless (i.e. outside the browser) environments, display is not necessary and so neither is styling necessary — thereby speeding up your code. You can manually enable styling in headless environments if you require it for a special case. Note that it does not make sense to disable style if you plan on rendering the graph. + * + * The default value is true. + */ + styleEnabled?: boolean; + /** + * When set to true, the renderer does not render edges while the viewport is being manipulated. This makes panning, zooming, dragging, et cetera more responsive for large graphs. + * + * The default value is false. + */ + hideEdgesOnViewport?: boolean; + /** + * hen set to true, the renderer does not render labels while the viewport is being manipulated. This makes panning, zooming, dragging, et cetera more responsive for large graphs. + * + * The default value is false. + */ + hideLabelsOnViewport?: boolean; + /** + * When set to true, the renderer uses a texture (if supported) during panning and zooming instead of drawing the elements, making large graphs more responsive. + * + * The default value is false. + */ + textureOnViewport?: boolean; + /** + * When set to true, the renderer will use a motion blur effect to make the transition between frames seem smoother. This can significantly increase the perceived performance for a large graphs. + * + * The default value is false. + */ + motionBlur?: boolean; + /** + * When motionBlur: true, this value controls the opacity of motion blur frames. Higher values make the motion blur effect more pronounced. + * + * The default value is 0.2. + */ + motionBlurOpacity?: number; + /** + * Changes the scroll wheel sensitivity when zooming. This is a multiplicative modifier. So, a value between 0 and 1 reduces the sensitivity (zooms slower), and a value greater than 1 increases the sensitivity (zooms faster). + * + * The default value is 1. + */ + wheelSensitivity?: number; + /** + * Overrides the screen pixel ratio with a manually set value (1.0 or 0.666 recommended, if set). This can be used to increase performance on high density displays by reducing the effective area that needs to be rendered. If you want to use the hardware's actual pixel ratio at the expense of performance, you can set pixelRatio: 'auto'. + * + * The default value is 1. + */ + pixelRatio?: number; + /** + * A callback function that is called when Cytoscape.js has rendered its first frame. This is useful for grabbing screenshots etc after initialision, but in general you should use ready instead. + */ + initrender?: (evt: any) => void; + /** + * A plain object containing options for the renderer to be used. The options.renderer.name field specifies which renderer is used. You need not specify anything for the renderer option, unless you want to specify one of the rendering options. + */ + renderer?: Renderer; + } + + interface ExportOptions { + /** + * The background colour of the image (transparent by default). + */ + bg?: string; + /** + * Whether to export the current viewport view (false, default) or the entire graph (true). + */ + full?: boolean; + /** + * This value specifies a positive number that scales the size of the resultant image. + */ + scale?: number; + /** + * Specifies the scale automatically in combination with maxHeight such that the resultant image is no wider than maxWidth. + */ + maxWidth?: number; + /** + * Specifies the scale automatically in combination with maxWidth such that the resultant image is no taller than maxHeight. + */ + maxHeight?: number; + } + + interface BoundingBoxOptions { + /** + * A boolean indicating whether to include nodes in the bounding box. + */ + includeNodes: boolean; + /** + * A boolean indicating whether to include edges in the bounding box. + */ + includeEdges: boolean; + /** + * A boolean indicating whether to include labels in the bounding box. + */ + includeLabels: boolean; + /** + * A boolean indicating whether to include shadows in the bounding box (default true). + */ + + includeShadows: boolean + } + + interface ZoomOptions { + /** + * The zoom level to set. + */ + level: number; + /** + * The position about which to zoom. + */ + position?: Position; + /** + * The rendered position about which to zoom. + */ + renderedPosition?: Position; + } + + interface Static { + (options?: CytoscapeOptions): Instance; + (extensionName: string, foo: string, bar: any): Instance; + version: string; + + Promise<T>(): Cy.Promise<T>; + } + + enum PromiseState { + STATE_PENDING = 0, + STATE_FULFILLED = 1, + STATE_REJECTED = 2 + + } + + interface Promise<T> { + id: string; + state: PromiseState; + fulfillValue: T; + rejectReason: any; + onFulfilled: any[]; + onRejected: any[]; + + fulfill(value: T): Promise<T>; + reject(error: any): Promise<any>; + then<U>(onFulfilled?: (value: T) => U | Promise<U>, onRejected?: (error: any) => U | Promise<U>): Promise<U>; + then<U>(onFulfilled?: (value: T) => U | Promise<U>, onRejected?: (error: any) => void): Promise<U>; + } +} + +declare module "cytoscape" { + export = cytoscape; +} + +declare var cytoscape: Cy.Static;
\ No newline at end of file |