@flexvertex/flexvertex-driver
Version:
The official FlexVertex Node.js driver
586 lines (134 loc) • 6.31 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: FlexSegment</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: FlexSegment</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>FlexSegment</h2>
<div class="class-description">Represents a segment tuple, containing a source object, connection, target object, and direction.
FlexSegments are typically used within a <a href="FlexJourney.html">FlexJourney</a>.</div>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="FlexSegment.html">FlexSegment</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="connection"><span class="type-signature"></span>connection<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>connection</code></td>
<td class="type">
<span class="param-type"><a href="FlexConnection.html">FlexConnection</a></span>
</td>
<td class="description last">Returns this FlexSegment's connection object</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="direction"><span class="type-signature"></span>direction<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>direction</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last">Returns this FlexSegment's directionality: 'Both', 'From', or 'To'</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="source"><span class="type-signature"></span>source<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>source</code></td>
<td class="type">
<span class="param-type"><a href="FlexObject.html">FlexObject</a></span>
</td>
<td class="description last">Returns this FlexSegment's source object</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="target"><span class="type-signature"></span>target<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>target</code></td>
<td class="type">
<span class="param-type"><a href="FlexObject.html">FlexObject</a></span>
</td>
<td class="description last">Returns this FlexSegment's target object</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FlexCargo.html">FlexCargo</a></li><li><a href="FlexCommons.html">FlexCommons</a></li><li><a href="FlexConnection.html">FlexConnection</a></li><li><a href="FlexJourney.html">FlexJourney</a></li><li><a href="FlexObject.html">FlexObject</a></li><li><a href="FlexResultSet.html">FlexResultSet</a></li><li><a href="FlexSchema.html">FlexSchema</a></li><li><a href="FlexSegment.html">FlexSegment</a></li><li><a href="FlexSession.html">FlexSession</a></li><li><a href="FlexVertex.html">FlexVertex</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Feb 23 2025 20:39:15 GMT-0700 (GMT-07:00)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>