Scalar 2 User's Guide Main Menu Getting Started Explains account and book creation, and some interface basics. QuickStarts A path of all QuickStart content in this user's guide. Working with Media How to get the most out of your use of media in Scalar. Working with Content Creating and editing content in Scalar. Working with Widgets Working with Structure How to use Scalar's many options for structuring publications. Editorial Workflow How to use features for performing editorial review of content. Visualizations Exploring the contents of a book visually. Lenses An introduction to lenses, a tool for searching and visualizing Scalar content. Advanced Topics Describing Scalar's more advanced features. Third Party Plugins and Platforms

ScalarRelation

3296
The ScalarRelation class describes a relationship between two ScalarNodes.

Properties

PropertyTypeDescription
bodyScalarNodeThe node that is the subject of the relationship.
endStringstringString describing the ending point of the relation (as with annotations).
idstringUnique id of the relation.
indexnumberThe relation’s sorting index relative to its siblings (as with pages in a path).
propertiesobjectAll known properties associated with the relation.
separatorstringAppropriate separate to insert between the startString and endString of the relation to express its span.
startStringstringString describing the starting point of the relation (as with annotations).
subTypestringRefines the type of an annotation relation. Possible values include “spatial”, “temporal”, or “textual”.
targetScalarNodeThe node that is the object of the relationship.
typeobjectObject literal describing the type of the relationship.

This page has paths:

  1. Scalar API JavaScript library reference Erik Loyer