Skip to content

Commit

Permalink
docs: fix hrefs (#1148)
Browse files Browse the repository at this point in the history
  • Loading branch information
kumilingus authored Jul 25, 2019
1 parent aa972cd commit 1e20b19
Show file tree
Hide file tree
Showing 12 changed files with 20 additions and 20 deletions.
8 changes: 4 additions & 4 deletions CHANGELOG
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

* allow for automatic patch upgrades for dependencies
* changes to config options are respected
* dia.Paper: ensure SVG document has id
* dia.Paper: fix viewport matching for links
* dia.Graph: make hasActiveBatches() use the same logic for various signatures
* dia.CellView: properly separate elements and ports CSS selectors
* dia.Paper - ensure SVG document has id
* dia.Paper - fix viewport matching for links
* dia.Graph - make hasActiveBatches() use the same logic for various signatures
* dia.CellView - properly separate elements and ports CSS selectors

27-06-2019 (v3.0.2)

Expand Down
6 changes: 3 additions & 3 deletions docs/src/geometry/api/g/Curve/prototype/divideAt.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

<p>Returns an array with two new curves without modifying the original curve. The function expects <code>ratio</code> to lie between 0 and 1; values outside the range are constrained to 0 and 1, respectively.</p>

<p>This function mirrors the functionality of the <code>line.divideAt()</code> <a href="geometry.html#g.line.prototype.divideAt">function</a>. If it is necessary to divide the curve at a certain <code>t</code> value instead, use the <code>curve.divideAtT()</code> <a href="geometry.html#g.curve.prototype.divideAtT">function</a>.</p>
<p>This function mirrors the functionality of the <code>line.divideAt()</code> <a href="geometry.html#g.Line.prototype.divideAt">function</a>. If it is necessary to divide the curve at a certain <code>t</code> value instead, use the <code>curve.divideAtT()</code> <a href="geometry.html#g.Curve.prototype.divideAtT">function</a>.</p>

<p>The function uses the same algorithm as the <code>curve.divideAtLength()</code> <a href="geometry.html#g.curve.prototype.divideAtLength">function</a>.</p>
<p>The function uses the same algorithm as the <code>curve.divideAtLength()</code> <a href="geometry.html#g.Curve.prototype.divideAtLength">function</a>.</p>

<p>The default value for <code>opt.precision</code> is 3; this corresponds to maximum observed error of 0.1%.</p>

<p>The <code>opt.subdivisions</code> property may be specified, directly providing an array of pre-computed curve subdivisions from which to calculate curve length. Use the <code>curve.getSubdivisions()</code> <a href="geometry.html#g.curve.prototype.getSubdivisions">function</a> to obtain an array of curve subdivisions. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm.</p>
<p>The <code>opt.subdivisions</code> property may be specified, directly providing an array of pre-computed curve subdivisions from which to calculate curve length. Use the <code>curve.getSubdivisions()</code> <a href="geometry.html#g.Curve.prototype.getSubdivisions">function</a> to obtain an array of curve subdivisions. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm.</p>
4 changes: 2 additions & 2 deletions docs/src/geometry/api/g/Curve/prototype/divideAtLength.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@

<p>Returns an array with two new curves without modifying the original curve. If negative <code>length</code> is provided, the algorithm starts looking from the end of the curve. If <code>length</code> is higher than curve length, the curve is divided at the closest endpoint instead.</p>

<p>The curve is first subdivided, according to <code>opt.precision</code> (refer to <code>curve.length()</code> <a href="geometry.html#g.curve.prototype.length">documentation</a> for more information about precision and curve flattening). Then, one subdivision is identified which contains the point at <code>length</code>. A binary search is then performed on that subdivision, until a curve is found whose endpoint lies within <code>opt.precision</code> away from <code>length</code>. That endpoint is used by the function to divide the curve.</p>
<p>The curve is first subdivided, according to <code>opt.precision</code> (refer to <code>curve.length()</code> <a href="geometry.html#g.Curve.prototype.length">documentation</a> for more information about precision and curve flattening). Then, one subdivision is identified which contains the point at <code>length</code>. A binary search is then performed on that subdivision, until a curve is found whose endpoint lies within <code>opt.precision</code> away from <code>length</code>. That endpoint is used by the function to divide the curve.</p>

<p>The default value for <code>opt.precision</code> is 3; this corresponds to maximum observed error of 0.1%.</p>

<p>As a rule of thumb, increasing precision by 1 doubles the number of operations needed to find the point to be returned (this is on top of the cost of curve subdivision); exact numbers vary for every individual curve, however.</p>

<p>The <code>opt.subdivisions</code> property may be specified, directly providing an array of pre-computed curve subdivisions from which to calculate curve length. Use the <code>curve.getSubdivisions()</code> <a href="geometry.html#g.curve.prototype.getSubdivisions">function</a> to obtain an array of curve subdivisions. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm.</p>
<p>The <code>opt.subdivisions</code> property may be specified, directly providing an array of pre-computed curve subdivisions from which to calculate curve length. Use the <code>curve.getSubdivisions()</code> <a href="geometry.html#g.Curve.prototype.getSubdivisions">function</a> to obtain an array of curve subdivisions. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm.</p>
2 changes: 1 addition & 1 deletion docs/src/geometry/api/g/Curve/prototype/divideAtT.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,4 @@

<p>Returns an array with two new curves without modifying the original curve. The function expects <code>t</code> to lie between 0 and 1; values outside the range are constrained to 0 and 1, respectively.</p>

<p>This function is not a counterpart to the <code>line.divideAt()</code> <a href="geometry.html#g.line.prototype.divideAt">function</a>. The relationship between <code>t</code> and distance along a curve is complex and non-linear. If it is necessary to divide the curve at a certain <code>ratio</code> (normalized length) away from beginning of the curve, use the <code>curve.divideAt()</code> <a href="geometry.html#g.curve.prototype.divideAt">function</a>.</p>
<p>This function is not a counterpart to the <code>line.divideAt()</code> <a href="geometry.html#g.Line.prototype.divideAt">function</a>. The relationship between <code>t</code> and distance along a curve is complex and non-linear. If it is necessary to divide the curve at a certain <code>ratio</code> (normalized length) away from beginning of the curve, use the <code>curve.divideAt()</code> <a href="geometry.html#g.Curve.prototype.divideAt">function</a>.</p>
4 changes: 2 additions & 2 deletions docs/src/geometry/api/g/Path/prototype/divideAt.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

<p>Returns an array with two new paths without modifying the original path. The returned paths are valid; that is, they both start with an appropriate Moveto segment. Additionally, Closepath segments are converted into Lineto segments if necessary. The function expects <code>ratio</code> to lie between 0 and 1; values outside the range are constrained to 0 and 1, respectively. Invisible segments (e.g. Moveto segments) have no length and are therefore skipped by the algorithm. If the path contains no visible segments, <code>null</code> is returned.</p>

<p>The function uses the same algorithm as the <code>path.divideAtLength()</code> <a href="geometry.html#g.path.prototype.divideAtLength">function</a>. It finds a visible segment which contains the point at length that corresponds to given <code>ratio</code> and then calls the segment's <code>divideAtLength()</code> function.</p>
<p>The function uses the same algorithm as the <code>path.divideAtLength()</code> <a href="geometry.html#g.Path.prototype.divideAtLength">function</a>. It finds a visible segment which contains the point at length that corresponds to given <code>ratio</code> and then calls the segment's <code>divideAtLength()</code> function.</p>

<p>The <code>opt</code> argument is optional. Two properties may be specified, <code>opt.precision</code> and <code>opt.segmentSubdivisions</code>, which determine maximum error allowed in <code>divideAtLength</code> <a href="geometry.html#g.curve.prototype.divideAtLength">calculations</a> for curved segments (default precision is 3; this corresponds to maximum observed error of 0.1%). The <code>opt.segmentSubdivisions</code> property is an array of individual segments' <a href="geometry.html#g.curve.prototype.getSubdivisions">subdivision arrays</a>. The <code>path.getSegmentSubdivisions()</code> <a href="geometry.html#g.path.prototype.getSegmentSubdivisions">function</a> may be used to obtain the <code>segmentSubdivisions</code> array. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm in curved segments.</p>
<p>The <code>opt</code> argument is optional. Two properties may be specified, <code>opt.precision</code> and <code>opt.segmentSubdivisions</code>, which determine maximum error allowed in <code>divideAtLength</code> <a href="geometry.html#g.Curve.prototype.divideAtLength">calculations</a> for curved segments (default precision is 3; this corresponds to maximum observed error of 0.1%). The <code>opt.segmentSubdivisions</code> property is an array of individual segments' <a href="geometry.html#g.Curve.prototype.getSubdivisions">subdivision arrays</a>. The <code>path.getSegmentSubdivisions()</code> <a href="geometry.html#g.Path.prototype.getSegmentSubdivisions">function</a> may be used to obtain the <code>segmentSubdivisions</code> array. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm in curved segments.</p>
4 changes: 2 additions & 2 deletions docs/src/geometry/api/g/Path/prototype/divideAtLength.html
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@

<p>Returns an array with two new paths without modifying the original path. The returned paths are valid; that is, they both start with an appropriate Moveto segment. Additionally, Closepath segments are converted into Lineto segments if necessary. If negative <code>length</code> is provided, the algorithm starts looking from the end of the path. If <code>length</code> is higher than path length, the path is divided at the closest visible path endpoint instead. Invisible segments (e.g. Moveto segments) have no length and are therefore skipped by the algorithm. If the path contains no visible segments, the <code>end</code> point of the last segment is returned. If the path has no segments at all, <code>null</code> is returned.</p>

<p>One visible segment is identified which contains the point at <code>length</code>. Finding the desired point is straightforward for linear segments (see <code>line.pointAtLength()</code> <a href="geometry.html#g.line.prototype.pointAtLength">for reference</a>). Finding the desired point in curved segments is more complex, as illustrated by the <code>curve.pointAtLength()</code> <a href="geometry.html#g.curve.prototype.pointAtLength">function</a>.
<p>One visible segment is identified which contains the point at <code>length</code>. Finding the desired point is straightforward for linear segments (see <code>line.pointAtLength()</code> <a href="geometry.html#g.Line.prototype.pointAtLength">for reference</a>). Finding the desired point in curved segments is more complex, as illustrated by the <code>curve.pointAtLength()</code> <a href="geometry.html#g.Curve.prototype.pointAtLength">function</a>.

<p>The <code>opt</code> argument is optional. Two properties may be specified, <code>opt.precision</code> and <code>opt.segmentSubdivisions</code>, which determine maximum error allowed in <code>pointAtLength</code> <a href="geometry.html#g.curve.prototype.pointAtLength">calculations</a> for curved segments (default precision is 3; this corresponds to maximum observed error of 0.1%). The <code>opt.segmentSubdivisions</code> property is an array of individual segments' <a href="geometry.html#g.curve.prototype.getSubdivisions">subdivision arrays</a>. The <code>path.getSegmentSubdivisions()</code> <a href="geometry.html#g.path.prototype.getSegmentSubdivisions">function</a> may be used to obtain the <code>segmentSubdivisions</code> array. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm in curved segments.</p>
<p>The <code>opt</code> argument is optional. Two properties may be specified, <code>opt.precision</code> and <code>opt.segmentSubdivisions</code>, which determine maximum error allowed in <code>pointAtLength</code> <a href="geometry.html#g.Curve.prototype.pointAtLength">calculations</a> for curved segments (default precision is 3; this corresponds to maximum observed error of 0.1%). The <code>opt.segmentSubdivisions</code> property is an array of individual segments' <a href="geometry.html#g.Curve.prototype.getSubdivisions">subdivision arrays</a>. The <code>path.getSegmentSubdivisions()</code> <a href="geometry.html#g.Path.prototype.getSegmentSubdivisions">function</a> may be used to obtain the <code>segmentSubdivisions</code> array. The <code>opt.precision</code> property is still necessary, however; it determines the precision of the point search algorithm in curved segments.</p>
2 changes: 1 addition & 1 deletion docs/src/joint/api/dia/Element/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ <h4 id="dia.Element.intro.nesting">Nesting</h4>

<h4 id="dia.Element.intro.events">Events</h4>

<p>Elements trigger several special events, detailed in the <a href="#dia.Elment.events">element events documentation</a>.</p>
<p>Elements trigger several special events, detailed in the <a href="#dia.Element.events">element events documentation</a>.</p>

<h4 id="dia.Element.intro.customElement">Custom Element</h4>

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<pre class="docs-method-signature"><code>elementView.getNodeBBox(magnet)</code></pre>
<p>Return the bounding box of the SVGElement provided as <code>magnet</code> (element/subelement/port of this element view).</p>

<p>Use the <code>paper.localToPaperRect</code> <a href="dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
<p>Use the <code>paper.localToPaperRect</code> <a href="#dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<pre class="docs-method-signature"><code>elementView.getNodeUnrotatedBBox(magnet)</code></pre>
<p>Return the unrotated bounding box of the SVGElement provided as <code>magnet</code> (element/subelement/port of this element view).</p>

<p>Use the <code>paper.localToPaperRect</code> <a href="dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
<p>Use the <code>paper.localToPaperRect</code> <a href="#dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
2 changes: 1 addition & 1 deletion docs/src/joint/api/dia/LinkView/prototype/getNodeBBox.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<pre class="docs-method-signature"><code>elementView.getNodeBBox(magnet)</code></pre>
<p>Return the bounding box of the SVGElement provided as <code>magnet</code> (model of this link view).</p>

<p>Use the <code>paper.localToPaperRect</code> <a href="dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
<p>Use the <code>paper.localToPaperRect</code> <a href="#dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<pre class="docs-method-signature"><code>elementView.getNodeUnrotatedBBox(magnet)</code></pre>
<p>Return the unrotated bounding box of the SVGElement provided as <code>magnet</code> (model of this link view).</p>

<p>Use the <code>paper.localToPaperRect</code> <a href="dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
<p>Use the <code>paper.localToPaperRect</code> <a href="#dia.Paper.prototype.localToPaperRect">function</a> to transform the returned bounding box to match the paper's translation and scaling.</p>
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p><code>sorting</code> - the sorting type to use when rendering the views in this paper (i.e. <q>In what order should the views be rendered?</q>).</p>

<p>The SVG 1.1 format does not have built-in z-index functionality, so JointJS implements it programmatically. You can set the z-index directly using using regular Backbone <code>set('z')</code>/<code>get('z')</code> methods or through <a href="#dia.Element.prototype.toFront"><code>element.toFront()</code></a>/<a href="#dia.Element.prototype.toBack"><code>element.toBack()</code></a>/<a href="#dia.Link.prototype.toFront"><code>link.toFront()</code></a>/<a href="#dia.Link.prototype.toBack"><code>link.toBack()</code></a> methods. See the <a href="dia.Element.intro.z">element Z documentation</a> for more information.</p>
<p>The SVG 1.1 format does not have built-in z-index functionality, so JointJS implements it programmatically. You can set the z-index directly using using regular Backbone <code>set('z')</code>/<code>get('z')</code> methods or through <a href="#dia.Element.prototype.toFront"><code>element.toFront()</code></a>/<a href="#dia.Element.prototype.toBack"><code>element.toBack()</code></a>/<a href="#dia.Link.prototype.toFront"><code>link.toFront()</code></a>/<a href="#dia.Link.prototype.toBack"><code>link.toBack()</code></a> methods. See the <a href="#dia.Element.intro.z">element Z documentation</a> for more information.</p>

<p>The Paper object exposes a <code>sorting</code> object with three values that may be used as values of this option:</p>

Expand Down

0 comments on commit 1e20b19

Please sign in to comment.