summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorjiteshjha2016-06-05 05:53:23 +0530
committerjiteshjha2016-06-05 05:53:23 +0530
commit411152d36c26cb25f4380bd89c76df5ebbbaf053 (patch)
tree8e7f97cce2c5a18805529eebdb5944777a11a9e4 /Documentation
parent42e35e62c8863add885c868f591412bb1813dd9c (diff)
downloadxcos-on-web-411152d36c26cb25f4380bd89c76df5ebbbaf053.tar.gz
xcos-on-web-411152d36c26cb25f4380bd89c76df5ebbbaf053.tar.bz2
xcos-on-web-411152d36c26cb25f4380bd89c76df5ebbbaf053.zip
New documentation folder added
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/Wires connection.md35
-rw-r--r--Documentation/Wires connection.md~35
2 files changed, 70 insertions, 0 deletions
diff --git a/Documentation/Wires connection.md b/Documentation/Wires connection.md
new file mode 100644
index 0000000..d75087d
--- /dev/null
+++ b/Documentation/Wires connection.md
@@ -0,0 +1,35 @@
+# XCOS Wires Connection
+#### @jiteshjha @pooja
+
+### function connectionHandlerIsStartEvent()
+
+ - Starts connections on the background in wire-mode.
+ - function connectionHandlerMouseUp() depends on this function.
+
+### function connectionHandlerMouseUp()
+
+ - Avoids any connections for gestures within tolerance except when in wire-mode or when over a port.
+ - Responsible for the removal of self connections over an mxCell (edges or vertices) in wire-mode.
+
+### function updateFixedTerminalPoint()
+
+ - Updates connection points before the routing is called.
+ - Enables connection from any point on an edge.
+ - Without this function, default edge characteristics ( mid-point-specific connections only) come in play.
+
+### function createEdgeState()
+
+ - Overrides methods to preview and create new edges.
+ - Enables horizontal and vertical edges in preview state.
+ - Without this function, any connection from an edge will have it's source point and target point chosen based on the assumed center of a straight edge having source edge's source point and target point.
+
+### function createMarker()
+
+ - Adds in-place highlighting for complete cell area (no hotspot).
+ - Uses complete area of cell for new connections.
+ - Adds in-place highlighting when reconnecting existing edges.
+
+### function WireConnector()
+
+ - Creates a custom horizontal and vertical edge style.
+ - Without this function, the source and terminal of a connection from an source edge is assumed as if the source edge were an perpendicular connection.
diff --git a/Documentation/Wires connection.md~ b/Documentation/Wires connection.md~
new file mode 100644
index 0000000..d75087d
--- /dev/null
+++ b/Documentation/Wires connection.md~
@@ -0,0 +1,35 @@
+# XCOS Wires Connection
+#### @jiteshjha @pooja
+
+### function connectionHandlerIsStartEvent()
+
+ - Starts connections on the background in wire-mode.
+ - function connectionHandlerMouseUp() depends on this function.
+
+### function connectionHandlerMouseUp()
+
+ - Avoids any connections for gestures within tolerance except when in wire-mode or when over a port.
+ - Responsible for the removal of self connections over an mxCell (edges or vertices) in wire-mode.
+
+### function updateFixedTerminalPoint()
+
+ - Updates connection points before the routing is called.
+ - Enables connection from any point on an edge.
+ - Without this function, default edge characteristics ( mid-point-specific connections only) come in play.
+
+### function createEdgeState()
+
+ - Overrides methods to preview and create new edges.
+ - Enables horizontal and vertical edges in preview state.
+ - Without this function, any connection from an edge will have it's source point and target point chosen based on the assumed center of a straight edge having source edge's source point and target point.
+
+### function createMarker()
+
+ - Adds in-place highlighting for complete cell area (no hotspot).
+ - Uses complete area of cell for new connections.
+ - Adds in-place highlighting when reconnecting existing edges.
+
+### function WireConnector()
+
+ - Creates a custom horizontal and vertical edge style.
+ - Without this function, the source and terminal of a connection from an source edge is assumed as if the source edge were an perpendicular connection.