Skip to content

Commit 0ca912f

Browse files
fix internal reference links
1 parent 49da867 commit 0ca912f

32 files changed

+162
-162
lines changed

_posts/plotly_js/2016-06-03-plotly_js_function_ref.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ <h4 id="retrieving-data-layout"><a href="{{ BASE_URL }}/javascript/plotlyjs-func
2424
<dd>The data to be plotted is described in an array usually called <code>data</code>, whose elements are trace objects of various types (e.g. <code>scatter</code>, <code>bar</code> etc) as documented <a href="{{ BASE_URL }}/javascript/reference">in the Full Reference</a>.
2525
</dd>
2626
<dt><code>layout</code></dt>
27-
<dd>The layout of the plot &ndash; non-data-related visual attributes such as the title, annotations etc &ndash; is described in an object usually called <code>layout</code>, as documented <a href="{{ BASE_URL }}/javascript/reference/#layout">in the Full Reference</a>.
27+
<dd>The layout of the plot &ndash; non-data-related visual attributes such as the title, annotations etc &ndash; is described in an object usually called <code>layout</code>, as documented <a href="{{ BASE_URL }}/javascript/reference/layout">in/ the Full Reference</a>.
2828
</dd>
2929
<dt><code>config</code></dt>
3030
<dd>High-level configuration options for the plot, such as the scroll/zoom/hover behaviour, is described in an object usually called <code>config</code>, as <a href="{{ BASE_URL }}/javascript/configuration-options">documented here</a>. The difference between <code>config</code> and <code>layout</code> is that <code>layout</code> relates to the content of the plot, whereas <code>config</code> relates to the context in which the plot is being shown.
@@ -54,7 +54,7 @@ <h4 id="plotly-newplot"><a href="{{ BASE_URL }}/javascript/plotlyjs-function-ref
5454
<dt><code>data</code></dt>
5555
<dd>array of objects, see <a href="{{ BASE_URL }}/javascript/reference">documentation</a> <br />(defaults to <code>[]</code>)</dd>
5656
<dt><code>layout</code></dt>
57-
<dd>object, see <a href="{{ BASE_URL }}/javascript/reference/#layout">documentation</a> <br />(defaults to <code>{}</code>)</dd>
57+
<dd>object, see <a href="{{ BASE_URL }}/javascript/reference/layout">documentation</a>/ <br />(defaults to <code>{}</code>)</dd>
5858
<dt><code>config</code></dt>
5959
<dd>object, see <a href="{{ BASE_URL }}/javascript/configuration-options">documentation</a> <br />(defaults to <code>{}</code>)</dd>
6060
</dl>
@@ -107,7 +107,7 @@ <h4 id="plotly-react"><a href="{{ BASE_URL }}/javascript/plotlyjs-function-refer
107107

108108
<code>Plotly.react</code> has the same signature as <a href="#plotlynewplot"><code>Plotly.newPlot</code></a> above, and can be used in its place to create a plot, but when called again on the same <code>&lt;div&gt;</code> will update it far more efficiently than <a href="#plotlynewplot"><code>Plotly.newPlot</code></a>, which would destroy and recreate the plot. <code>Plotly.react</code> is as fast as <code>Plotly.restyle</code>/<code>Plotly.relayout</code> documented below.
109109
<br /><br />
110-
Important Note: In order to use this method to plot new items in arrays under <code>data</code> such as <code>x</code> or <code>marker.color</code> etc, these items must either have been added immutably (i.e. the identity of the parent array must have changed) or the value of <a href="{{ BASE_URL }}/javascript/reference/#layout-datarevision"><code>layout.datarevision</code></a> must have changed.
110+
Important Note: In order to use this method to plot new items in arrays under <code>data</code> such as <code>x</code> or <code>marker.color</code> etc, these items must either have been added immutably (i.e. the identity of the parent array must have changed) or the value of <a href="{{ BASE_URL }}/javascript/reference/layout/#layout-datarevision"><code>layout.datarevision</code></a> must have changed.
111111

112112
<h4 id="plotly-plot"><a href="{{ BASE_URL }}/javascript/plotlyjs-function-reference/#plotlyplot">Plotly.plot</a></h4>
113113

Lines changed: 79 additions & 79 deletions
Original file line numberDiff line numberDiff line change
@@ -1,79 +1,79 @@
1-
---
2-
name: 3D Point Clustering
3-
language: plotly_js
4-
suite: 3d-cluster
5-
order: 0
6-
sitemap: false
7-
arrangement: horizontal
8-
---
9-
Plotly.d3.csv('https://raw.githubusercontent.com/plotly/datasets/master/alpha_shape.csv', function(err, rows){
10-
11-
function unpack(rows, key) {
12-
return rows.map(function(row) { return row[key]; });
13-
}
14-
15-
var data = [{
16-
x: unpack(rows, 'x'),
17-
y: unpack(rows, 'y'),
18-
z: unpack(rows, 'z'),
19-
mode: 'markers',
20-
type: 'scatter3d',
21-
marker: {
22-
color: 'rgb(23, 190, 207)',
23-
size: 2
24-
}
25-
},{
26-
alphahull: 7,
27-
opacity: 0.1,
28-
type: 'mesh3d',
29-
x: unpack(rows, 'x'),
30-
y: unpack(rows, 'y'),
31-
z: unpack(rows, 'z')
32-
}];
33-
34-
var layout = {
35-
autosize: true,
36-
height: 480,
37-
scene: {
38-
aspectratio: {
39-
x: 1,
40-
y: 1,
41-
z: 1
42-
},
43-
camera: {
44-
center: {
45-
x: 0,
46-
y: 0,
47-
z: 0
48-
},
49-
eye: {
50-
x: 1.25,
51-
y: 1.25,
52-
z: 1.25
53-
},
54-
up: {
55-
x: 0,
56-
y: 0,
57-
z: 1
58-
}
59-
},
60-
xaxis: {
61-
type: 'linear',
62-
zeroline: false
63-
},
64-
yaxis: {
65-
type: 'linear',
66-
zeroline: false
67-
},
68-
zaxis: {
69-
type: 'linear',
70-
zeroline: false
71-
}
72-
},
73-
title: '3d point clustering',
74-
width: 477
75-
};
76-
77-
Plotly.newPlot('myDiv', data, layout);
78-
79-
});
1+
---
2+
name: 3D Point Clustering
3+
language: plotly_js
4+
suite: 3d-cluster
5+
order: 0
6+
sitemap: false
7+
arrangement: horizontal
8+
---
9+
Plotly.d3.csv('https://raw.githubusercontent.com/plotly/datasets/master/alpha_shape.csv', function(err, rows){
10+
11+
function unpack(rows, key) {
12+
return rows.map(function(row) { return row[key]; });
13+
}
14+
15+
var data = [{
16+
x: unpack(rows, 'x'),
17+
y: unpack(rows, 'y'),
18+
z: unpack(rows, 'z'),
19+
mode: 'markers',
20+
type: 'scatter3d',
21+
marker: {
22+
color: 'rgb(23, 190, 207)',
23+
size: 2
24+
}
25+
},{
26+
alphahull: 7,
27+
opacity: 0.1,
28+
type: 'mesh3d',
29+
x: unpack(rows, 'x'),
30+
y: unpack(rows, 'y'),
31+
z: unpack(rows, 'z')
32+
}];
33+
34+
var layout = {
35+
autosize: true,
36+
height: 480,
37+
scene: {
38+
aspectratio: {
39+
x: 1,
40+
y: 1,
41+
z: 1
42+
},
43+
camera: {
44+
center: {
45+
x: 0,
46+
y: 0,
47+
z: 0
48+
},
49+
eye: {
50+
x: 1.25,
51+
y: 1.25,
52+
z: 1.25
53+
},
54+
up: {
55+
x: 0,
56+
y: 0,
57+
z: 1
58+
}
59+
},
60+
xaxis: {
61+
type: 'linear',
62+
zeroline: false
63+
},
64+
yaxis: {
65+
type: 'linear',
66+
zeroline: false
67+
},
68+
zaxis: {
69+
type: 'linear',
70+
zeroline: false
71+
}
72+
},
73+
title: '3d point clustering',
74+
width: 477
75+
};
76+
77+
Plotly.newPlot('myDiv', data, layout);
78+
79+
});

_posts/plotly_js/3d/3d-surface/2018-10-09-surface-contours.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
sitemap: false
77
arrangement: horizontal
88
markdown_content: |
9-
Display and customize contour data for each axis using the `contours` attribute ([reference](plot.ly/javascript/reference/#surface-contours)).
9+
Display and customize contour data for each axis using the `contours` attribute ([reference](plot.ly/javascript/reference/surface/#surface-contours)).
1010

1111
---
1212

_posts/plotly_js/basic/bubble/2015-08-10-size-scaling-bubblechart.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
---
99
// To scale the bubble size, use the attribute sizeref. We recommend using the following formula to calculate a sizeref value:
1010
// sizeref = 2.0 * Math.max(...size) / (desired_maximum_marker_size**2)
11-
// Note that setting 'sizeref' to a value greater than 1, decreases the rendered marker sizes, while setting 'sizeref' to less than 1, increases the rendered marker sizes. See https://plotly.com/python/reference/#scatter-marker-sizeref for more information. Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/#scatter-marker-sizemode to area.
11+
// Note that setting 'sizeref' to a value greater than 1, decreases the rendered marker sizes, while setting 'sizeref' to less than 1, increases the rendered marker sizes. See https://plotly.com/python/reference/scatter/#scatter-marker-sizeref for more information. Additionally, we recommend setting the sizemode attribute: https://plotly.com/python/reference/scatter/#scatter-marker-sizemode to area.
1212

1313
var trace1 = {
1414
x: [1, 2, 3, 4],

_posts/plotly_js/basic/pie/2015-08-10-pie-chart-subplots.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
sitemap: false
77
arrangement: horizontal
88
markdown_content: |
9-
In order to create pie chart subplots, you need to use the [domain](https://plotly.com/javascript/reference/#pie-domain) attribute. `domain` allows you to place each trace on a [grid](https://plotly.com/javascript/reference/#layout-grid) of rows and columns defined in the layout or within a rectangle defined by `X` and `Y` arrays. The example below uses the `grid` method (with a 2 x 2 grid defined in the layout) for the first three traces and the X and Y method for the fourth trace.
9+
In order to create pie chart subplots, you need to use the [domain](https://plotly.com/javascript/reference/pie/#pie-domain) attribute. `domain` allows you to place each trace on a [grid](https://plotly.com/javascript/reference/layout/#layout-grid) of rows and columns defined in the layout or within a rectangle defined by `X` and `Y` arrays. The example below uses the `grid` method (with a 2 x 2 grid defined in the layout) for the first three traces and the X and Y method for the fourth trace.
1010
---
1111

1212
var allLabels = ['1st', '2nd', '3rd', '4th', '5th'];

_posts/plotly_js/basic/sankey/2019-11-20-nodes-position.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
arrangement: horizontal
88
description:
99
markdown_content: |
10-
The following example sets [node.x](https://plotly.com/javascript/reference/#sankey-node-x) and `node.y` to place nodes in the specified locations, except in the `snap arrangement` (default behaviour when `node.x` and `node.y` are not defined) to avoid overlapping of the nodes, therefore, an automatic snapping of elements will be set to define the padding between nodes via [nodepad](https://plotly.com/javascript/reference/#sankey-node-pad). The other possible arrangements are:<font color='blue'> 1)</font> perpendicular <font color='blue'>2)</font> freeform <font color='blue'>3)</font> fixed
10+
The following example sets [node.x](https://plotly.com/javascript/reference/sankey/#sankey-node-x) and `node.y` to place nodes in the specified locations, except in the `snap arrangement` (default behaviour when `node.x` and `node.y` are not defined) to avoid overlapping of the nodes, therefore, an automatic snapping of elements will be set to define the padding between nodes via [nodepad](https://plotly.com/javascript/reference/sankey/#sankey-node-pad). The other possible arrangements are:<font color='blue'> 1)</font> perpendicular <font color='blue'>2)</font> freeform <font color='blue'>3)</font> fixed
1111

1212
---
1313
var data = [{

_posts/plotly_js/basic/sunburst/2019-04-11-sunburst_plotly_js_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","sunburst" | sort: "order" %}
1414
{% include posts/auto_examples.html examples=examples %}
1515

16-
See <a href="https://plotly.com/javascript/reference/#sunburst">https://plotly.com/javascript/reference/#sunburst</a> for more information and chart attribute options!
16+
See <a href="https://plotly.com/javascript/reference/sunburst">https://plotly/.com/javascript/reference/sunburst</a>/ for more information and chart attribute options!

_posts/plotly_js/basic/treemap/2019-10-15-basic-treemap.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
sitemap: false
77
arrangement: horizontal
88
markdown_content: |
9-
[Treemap charts](https://en.wikipedia.org/wiki/Treemapping) visualize hierarchical data using nested rectangles. Same as [Sunburst](https://plotly.com/javascript/sunburst-charts/) the hierarchy is defined by [labels](https://plotly.com/javascript/reference/#treemap-labels) and [parents](https://plotly.com/javascript/reference/#treemap-parents) attributes. Click on one sector to zoom in/out, which also displays a pathbar in the upper-left corner of your treemap. To zoom out you can use the path bar as well.
9+
[Treemap charts](https://en.wikipedia.org/wiki/Treemapping) visualize hierarchical data using nested rectangles. Same as [Sunburst](https://plotly.com/javascript/sunburst-charts/) the hierarchy is defined by [labels](https://plotly.com/javascript/reference/treemap/#treemap-labels) and [parents](https://plotly.com/javascript/reference/treemap/#treemap-parents) attributes. Click on one sector to zoom in/out, which also displays a pathbar in the upper-left corner of your treemap. To zoom out you can use the path bar as well.
1010
---
1111
data = [{
1212
type: "treemap",

_posts/plotly_js/basic/treemap/2019-10-15-nested-layers-treemap.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
sitemap: false
77
arrangement: horizontal
88
markdown_content: |
9-
The following example uses hierarchical data that includes layers and grouping. Treemap and [Sunburst](https://plotly.com/javascript/sunburst-charts/) charts reveal insights into the data, and the format of your hierarchical data. [maxdepth](https://plotly.com/javascript/reference/#treemap-maxdepth) attribute sets the number of rendered sectors from the given level.
9+
The following example uses hierarchical data that includes layers and grouping. Treemap and [Sunburst](https://plotly.com/javascript/sunburst-charts/) charts reveal insights into the data, and the format of your hierarchical data. [maxdepth](https://plotly.com/javascript/reference/treemap/#treemap-maxdepth) attribute sets the number of rendered sectors from the given level.
1010
---
1111
Plotly.d3.csv('https://raw.githubusercontent.com/plotly/datasets/master/coffee-flavors.csv', function(err, rows){
1212
function unpack(rows, key) {

_posts/plotly_js/basic/treemap/2019-10-15-set-marker-color-treemap.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
arrangement: horizontal
88
markdown_content: |
99
There are three different ways to change the color of the sectors in Treemap:
10-
1) [marker.colors](https://plotly.com/javascript/reference/#treemap-marker-colors), 2) [colorway](https://plotly.com/javascript/reference/#layout-colorway), 3) [colorscale](https://plotly.com/javascript/reference/#treemap-marker-colorscale). The following examples show how to use each of them.
10+
1) [marker.colors](https://plotly.com/javascript/reference/treemap/#treemap-marker-colors), 2) [colorway](https://plotly.com/javascript/reference/layout/#layout-colorway), 3) [colorscale](https://plotly.com/javascript/reference/treemap/#treemap-marker-colorscale). The following examples show how to use each of them.
1111
---
1212
var labels = ["A1", "A2", "A3", "A4", "A5", "B1", "B2"];
1313
var parents = ["", "A1", "A2", "A3", "A4", "", "B1"];

_posts/plotly_js/basic/treemap/2019-10-15-treemap_attributes.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88
markdown_content: |
99
This example uses the following attributes:
1010
<ol>
11-
<li> [values](https://plotly.com/javascript/reference/#treemap-values): sets the values associated with each of the sectors.</li>
12-
<li> [textinfo](https://plotly.com/javascript/reference/#treemap-textinfo): determines which trace information appear on the graph that can be 'text', 'value', 'current path', 'percent root', 'percent entry', and 'percent parent', or any combination of them. </li>
13-
<li> [pathbar](https://plotly.com/javascript/reference/#treemap-pathbar): a main extra feature of treemap to display the current path of the visible portion of the hierarchical map. It may also be useful for zooming out of the graph.</li>
14-
<li> [branchvalues](https://plotly.com/javascript/reference/#treemap-branchvalues): determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. In the example below Eva = 65, which is equal to 14 + 12 + 10 + 2 + 6 + 6 + 1 + 4. </li>
11+
<li> [values](https://plotly.com/javascript/reference/treemap/#treemap-values): sets the values associated with each of the sectors.</li>
12+
<li> [textinfo](https://plotly.com/javascript/reference/treemap/#treemap-textinfo): determines which trace information appear on the graph that can be 'text', 'value', 'current path', 'percent root', 'percent entry', and 'percent parent', or any combination of them. </li>
13+
<li> [pathbar](https://plotly.com/javascript/reference/treemap/#treemap-pathbar): a main extra feature of treemap to display the current path of the visible portion of the hierarchical map. It may also be useful for zooming out of the graph.</li>
14+
<li> [branchvalues](https://plotly.com/javascript/reference/treemap/#treemap-branchvalues): determines how the items in `values` are summed. When set to "total", items in `values` are taken to be value of all its descendants. In the example below Eva = 65, which is equal to 14 + 12 + 10 + 2 + 6 + 6 + 1 + 4. </li>
1515
</ol>
1616
When set to "remainder", items in `values` corresponding to the root and the branches sectors are taken to be the extra part not part of the sum of the values at their leaves.
1717
---

_posts/plotly_js/basic/treemap/2019-10-15-treemap_plotly_js_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313
{% assign examples = site.posts | where:"language","plotly_js" | where:"suite","treemap" | sort: "order" %}
1414
{% include posts/auto_examples.html examples=examples %}
1515

16-
See <a href="https://plotly.com/javascript/reference/#treemap">https://plotly.com/javascript/reference/#treemap</a> for more information and chart attribute options!
16+
See <a href="https://plotly.com/javascript/reference/treemap">https://plotly/.com/javascript/reference/treemap</a>/ for more information and chart attribute options!
Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
---
2-
name: Click Event Data
3-
language: plotly_js
4-
suite: click-events
5-
sitemap: false
6-
order: 0
7-
---
8-
9-
{
10-
points: [{
11-
curveNumber: 2, // index in data of the trace associated with the selected point
12-
pointNumber: 2, // index of the selected point
13-
x: 5, // x value
14-
y: 600, // y value
15-
data: {/* */}, // ref to the trace as sent to Plotly.newPlot associated with the selected point
16-
fullData: {/* */}, // ref to the trace including all the defaults
17-
xaxis: {/* */}, // ref to x-axis object (i.e layout.xaxis) associated with the selected point
18-
yaxis: {/* */} // ref to y-axis object " "
19-
}, {
20-
/* similarly for other selected points */
21-
}]
22-
}
1+
---
2+
name: Click Event Data
3+
language: plotly_js
4+
suite: click-events
5+
sitemap: false
6+
order: 0
7+
---
8+
9+
{
10+
points: [{
11+
curveNumber: 2, // index in data of the trace associated with the selected point
12+
pointNumber: 2, // index of the selected point
13+
x: 5, // x value
14+
y: 600, // y value
15+
data: {/* */}, // ref to the trace as sent to Plotly.newPlot associated with the selected point
16+
fullData: {/* */}, // ref to the trace including all the defaults
17+
xaxis: {/* */}, // ref to x-axis object (i.e layout.xaxis) associated with the selected point
18+
yaxis: {/* */} // ref to y-axis object " "
19+
}, {
20+
/* similarly for other selected points */
21+
}]
22+
}

0 commit comments

Comments
 (0)