5.8 KiB
{% assign title = "References" %} {% assign definition = site.data.concepts.reference %} {% assign preposition = "" %} {% assign plural = "" %}
{% if include.more == "yes" and include.heading == "more" %}
Click to learn more about {{ title | downcase }}{{plural}}
{% endif %}{% if include.heading != "" and include.heading != "more" %} {{include.heading}} {{title}} {% endif %}
{% if include.icon != "no" %}
{% if include.table == "yes" and include.icon != "no" %}
{% endif %}
{% if include.table == "yes" and include.icon != "no" %} |
{% endif %}
{% endif %} {% if include.definition == "bold" %} {{ definition }} {% else %} {% if include.definition != "no" %} {{ definition }} {% endif %} {% endif %} {% if include.table == "yes" and include.icon != "no" %} |
{% if include.more == "yes" and include.content == "more" and include.heading != "more" %}
Click to learn more about {{ title | downcase }}{{plural}}
{% endif %}{% if include.content != "no" %}
{{include.heading}}## Establishing and Removing References
To establish a reference, right-click on the first node and drag it close to the target node. Grey rings show which nodes you may establish a reference with. In case there are multiple nodes that would accept the reference, the one closer to the node where the reference originates will have its ring highlighted. Releasing the mouse button establishes the reference, or links both nodes.
The reference is visually represented by a faint grey dotted line. Such line is visible only when both ends of the reference are visible.
To remove a reference or delink two nodes, simply right-click the node where the reference originates and make a dentle swipping motion away from the target node.
{% include note.html content="Throughout this documentation we may use the verbs to link, to reference or to establish a reference interchangeably, as synonyms." %}
{% endif %}
{% if include.more == "yes" and include.extended == "more" and include.content != "more" and include.heading != "more" %}
Click to learn more about {{ title | downcase }}{{plural}}
{% endif %}{% if include.extended != "no" %}
{{include.heading}}## Direction
References have a direction property relative to each of the nodes involved in the reference: the node establishing the reference sets an outgoing reference, while the one accepting the reference sets an incoming reference.
For example, a session establishes an outgoing reference with a trading system. This allows the session to access the information within the whole trading system hierarchy, including strategies. At the trading system level, the same reference is viewed as an incoming reference.
{{include.heading}}## Scope
A reference established between nodes of any particular structure within a hierarchy is said to be an internal reference relative to the said structure of nodes. Similarly, a reference established with a node outside of the said structure, that is, in a different part of the hierarchy or in another hierarchy, is said to be an external reference.
Examples of internal references may be found in the data mine and crypto ecosystem hierarchies. For example, let's briefly look into one such case within a plotter module:
The capture below shows the shapes node and several offspring nodes: on one hand, several polygons; on the other hand, the chart points node.
Notice that vertices under each polygon reference to points under the chart points node.
This means that the node shapes feature several internal references.
{% include note.html content="The backup, clone and share operations make different uses of the properties of references. We will cover the three of them extensively so that you may make the most of these features." %}
{% endif %}
{% if include.more == "yes" %}