diff --git a/libgraphtheory/kernel/modules/document/document.xml b/libgraphtheory/kernel/modules/document/document.xml index f32bb395..3690c003 100644 --- a/libgraphtheory/kernel/modules/document/document.xml +++ b/libgraphtheory/kernel/modules/document/document.xml @@ -1,143 +1,143 @@ Document Document Document The document object provides access to all elements. node(id) Return the node with specified ID. Node id int Identifier of a node. nodes() Return a list of all nodes. array nodes(type) Return a list all nodes of specified type. array type int Identifier of a node type. edges() Return a list of all edges. array edges(type) Return a list all edges of specified type. array type int Identifier of an edge type. createNode(int x, int y) Create node at position (x,y). Node x int X-coordinate of the node. y int Y-coordinate of the node. createEdge(from, to) Create edge between the given nodes of default edge type. Edge from Node Start node of the edge. to Node Target node of the edge. remove(node) Delete the given node. void node Node - The to be deleted node. + The node to be deleted. remove(edge) Delete the given edge. void edge Edge - The to be deleted edge. + The edge to be deleted. diff --git a/libgraphtheory/kernel/modules/document/node.xml b/libgraphtheory/kernel/modules/document/node.xml index 7aedefa7..085bde34 100644 --- a/libgraphtheory/kernel/modules/document/node.xml +++ b/libgraphtheory/kernel/modules/document/node.xml @@ -1,211 +1,211 @@ Node Node Node A node is the data element of a graph. It can have arbitrary dynamic properties that are either set in the editor or simply assigned on run-time. Note that dynamic properties are only available after script execution, if they are registered for the node's type. id Read and set the unique identifier of this node. int x Read and set the x-coordinate of the node. real y Read and set the y-coordinate of the node. real color Read and set the color string of this node in hex values (e.g., "#ff0000" for red). string type - Read at set the identifier of the node's type. If setting, the node type identifier must exist. + Read and set the identifier of the node's type. If setting, the node type identifier must exist. string edges() Return a list of all edges (incoming and outgoing) of this node. array edges(type) Return a list of all edges (incoming and outgoing) of this node of a specified type. array type int Identifier of an edge type. inEdges() Return a list of incoming edges of this node. array inEdges(type) Return a list of all incoming edges of this node of a specified type. array type int Identifier of an edge type. outEdges() Return a list of all outgoing edges of this node. array outEdges(type) Return a list of all outgoing edges of this node of a specified type. array type int Identifier of an edge type. neighbors() Return list all nodes connected to this node. This method respects if edges are directed. array neighbors(type) Return list all nodes connected to this node via an edge of specified type. This method respects if edges are directed. array type int Identifier of an edge type. predecessors() Return a list all nodes connected to this node by an incoming edge. array predecessors(type) Return a list all nodes connected to this node by an incoming edge of specified type. array type int Identifier of an edge type. successors() Return list all nodes connected to this node by an outgoing edge. array successors(type) Return list all nodes connected to this node by an outgoing edge of specified type. array type int Identifier of an edge type. distance(property, targets) Return list of distances to specified targets in same order. array property string Name of edge property that holds the edge length. targets array List of nodes to that the distances shall be computed.