API Docs for: trial
Show:

nx.data.EdgeSetCollection Class

Extends nx.data.Edge
Module: nx.data

Edge set collection class

Methods

addEdge

(
  • data
  • [config]
)
nx.data.Edge

Add edge to Graph

Parameters:

  • data JSON

    Vertex original data

  • [config] Object optional

    Config object

Returns:

addEdgeSet

(
  • edgeSet
)

Add child edgeSet

Parameters:

addVertex

(
  • data
  • [config]
)
nx.data.Vertex

Add vertex to Graph

Parameters:

  • data JSON

    Vertex original data

  • [config] Object optional

    Config object

Returns:

addVertexSet

(
  • data
  • [config]
)
nx.data.VertexSet

Add vertex set to Graph

Parameters:

  • data JSON

    Vertex set original data, which include nodes(Array) attribute. That is node's ID collection. e.g. {nodes:[id1,id2,id3]}

  • [config] Object optional

    Config object

Returns:

clearBinding

(
  • prop
)

Inherited from nx.Observable:

Clear binding for specified property.

Parameters:

(
  • names
  • handler
  • context
)

Inherited from nx.Observable:

Parameters:

dispose

()

Inherited from nx.Observable

Dispose current object.

get

(
  • name
)

Inherited from nx.data.ObservableObject:

Get specified property value.

Parameters:

Returns:

:

getBinding

(
  • prop
)

Inherited from nx.Observable:

Get existing binding object for specified property.

Parameters:

Returns:

:

getData

() Object

Inherited from nx.data.Edge:

Get original data

Returns:

getEdgesBySourceAndTarget

(
  • source
  • target
)
Array

Get edges by source vertex id and target vertex id

Parameters:

Returns:

getEdgesByVertices

(
  • inVertices
)
Array

Get edges which are connected to passed vertices

Parameters:

Returns:

getEdgeSetBySourceAndTarget

(
  • source
  • target
)
nx.data.EdgeSet

Get edgeSet by source vertex id and target vertex id

Parameters:

Returns:

getInternalEdgesByVertices

(
  • inVertices
)
Array

Get edges which's source and target vertex are both in the passed vertices

Parameters:

Returns:

getInternalEdgesByVertices

(
  • inVertices
)
Array

Get edges which's just one of source or target vertex in the passed vertices. All edges connected ourside of passed vertices

Parameters:

Returns:

gets

() Object

Inherited from nx.data.ObservableObject:

Get all properties.

Returns:

has

(
  • name
)
Boolean

Inherited from nx.data.ObservableObject:

Check whether current object has specified property.

Parameters:

Returns:

notify

(
  • names
  • oldValue
)

Inherited from nx.Observable:

Parameters:

removeEdge

(
  • id
  • isUpdateEdgeSet
)

Remove edge from Graph

Parameters:

removeEdgeSet

(
  • linkKey
)

Remove child edgeSet

Parameters:

removeVertex

(
  • id
)
Boolean

Delete a vertex from Graph

Parameters:

  • id Id

Returns:

removeVertex

(
  • id
)
Boolean

Remove a vertex from Graph

Parameters:

Returns:

removeVertexSet

(
  • id
)
Boolean

Remove a vertex set from Graph

Parameters:

Returns:

set

(
  • name
  • value
)

Inherited from nx.data.ObservableObject:

Set specified property value.

Parameters:

setBinding

(
  • prop
  • expr
  • source
)

Inherited from nx.Observable:

Set binding for specified property.

Parameters:

unwatch

(
  • names
  • handler
  • context
)

Inherited from nx.Observable:

Parameters:

Properties

edgeSets

Object

All child edgeset

generated

Boolean

Inherited from nx.data.Edge:

Status property,tag is this edge generated

Default: false

graph

nx.data.ObservableGraph

Inherited from nx.data.Edge:

Graph instance

id

String | Number

Inherited from nx.data.Edge:

Edge's id

line

nx.geometry.Line

Inherited from nx.data.Edge:

Edge line object

linkKey

String

Inherited from nx.data.Edge:

Edge's linkkey, linkkey = sourceID-targetID

parentEdgeSet

nx.data.edgeSet

Inherited from nx.data.Edge:

Edge's parent edge set

position

Object

Inherited from nx.data.Edge:

Edge position object {{x1: (Number), y1: (Number), x2: (Number), y2: (Number)}}

reverse

Boolean

Inherited from nx.data.Edge:

Is this link is a reverse link

reverseLinkKey

String

Inherited from nx.data.Edge:

Edge's reverse linkkey,reverseLinkKey = targetID + '_' + sourceID

source

nx.data.Vertex

Inherited from nx.data.Edge:

Source vertex

sourceID

String | Number

Inherited from nx.data.Edge:

Source vertex id

target

nx.data.Vertex

Inherited from nx.data.Edge:

Target vertex

targetID

String | Number

Inherited from nx.data.Edge:

Target vertex id

type

String

Inherited from nx.data.Edge

Edge's type

Default: 'edgeSet'

updated

Boolean

Inherited from nx.data.Edge:

Status property,tag is this edge updated

Default: false

Events

addEdge

Event Payload:

addEdgeSet

Event Payload:

addVertex

Event Payload:

deleteEdge

Event Payload:

removeEdge

Event Payload:

removeEdgeSet

Event Payload:

removeEdgeSet

Event Payload:

removeEdgeSet

Event Payload:

removeEdgeSet

Event Payload:

removeVertex

Event Payload:

updateEdgeSet

Event Payload:

updateVertexCoordinate

Event Payload:

updateVertexSet

Event Payload:

updateVertexSetCoordinate

Event Payload: