plotly.py-docs/generated/plotly.graph_objects.Sankey.html at debug · plotly/plotly.py-docs

History

275 lines (243 loc) · 20.8 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

<!DOCTYPE html>

<head>

<title>plotly.graph_objects.Sankey — 4.6.0 documentation</title>

</head><body>

</button>

</a>

</div>

<a role="button"

id="dLabelGlobalToc"

data-toggle="dropdown"

data-target="#"

href="../index.html">Site </a>

<ul class="dropdown-menu globaltoc"

role="menu"

aria-labelledby="dLabelGlobalToc"><ul class="current">

<li class="toctree-l1"><a class="reference internal" href="../plotly.express.html"><code class="docutils literal notranslate">plotly.express</code>: high-level interface for data visualization</a></li>

<li class="toctree-l1 current"><a class="reference internal" href="../plotly.graph_objects.html"><code class="docutils literal notranslate">plotly.graph_objects</code>: low-level interface to figures, traces and layout</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.subplots.html"><code class="docutils literal notranslate">plotly.subplots</code>: helper function for laying out multi-plot figures</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.figure_factory.html"><code class="docutils literal notranslate">plotly.figure_factory</code>: helper methods for building specific complex charts</a></li>

<li class="toctree-l1"><a class="reference internal" href="../plotly.io.html"><code class="docutils literal notranslate">plotly.io</code>: low-level interface for displaying, reading and writing figures</a></li>

</ul>

</li>

<a role="button"

id="dLabelLocalToc"

data-toggle="dropdown"

data-target="#"

href="#">Page </a>

<ul class="dropdown-menu localtoc"

role="menu"

aria-labelledby="dLabelLocalToc"><ul>

<li><a class="reference internal" href="#"><code class="xref py py-mod docutils literal notranslate">plotly.graph_objects</code>.Sankey</a></li>

<li><a class="reference internal" href="#id1"><code class="xref py py-mod docutils literal notranslate">plotly.graph_objects</code>.sankey</a></li>

</ul>

</li>

<li>

<a href="plotly.graph_objects.Treemap.html" title="Previous Chapter: plotly.graph_objects.Treemap">« plotly.graph_...

</a>

</li>

<li>

<a href="plotly.graph_objects.Splom.html" title="Next Chapter: plotly.graph_objects.Splom">plotly.graph_... »

</a>

</li>

</ul>

</div>

</form>

</div>

<h1><a class="reference internal" href="plotly.graph_objects.html#module-plotly.graph_objects" title="plotly.graph_objects"><code class="xref py py-mod docutils literal notranslate">plotly.graph_objects</code></a>.Sankey<a class="headerlink" href="#plotly-graph-objs-sankey" title="Permalink to this headline">¶</a></h1>

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Sankey</code>(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Sankey" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, arrangement=None, customdata=None, customdatasrc=None, domain=None, hoverinfo=None, hoverlabel=None, ids=None, idssrc=None, link=None, meta=None, metasrc=None, name=None, node=None, orientation=None, selectedpoints=None, stream=None, textfont=None, uid=None, uirevision=None, valueformat=None, valuesuffix=None, visible=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Sankey.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Sankey object

Sankey plots for network flow data analysis. The nodes are

specified in <code class="docutils literal notranslate">nodes</code> and the links between sources and targets

in <code class="docutils literal notranslate">links</code>. The colors are set in <code class="docutils literal notranslate">nodes[i].color</code> and

<code class="docutils literal notranslate">links[i].color</code>, otherwise defaults are used.

<dt class="field-odd">Parameters</dt>

<li>arg – dict of properties compatible with this constructor or

an instance of <a class="reference internal" href="#plotly.graph_objects.Sankey" title="plotly.graph_objects.Sankey"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.Sankey</code></a></li>

<li>arrangement – If value is <code class="docutils literal notranslate">snap</code> (the default), the node arrangement

is assisted by automatic snapping of elements to

preserve space between nodes specified via <code class="docutils literal notranslate">nodepad</code>.

If value is <code class="docutils literal notranslate">perpendicular</code>, the nodes can only move

along a line perpendicular to the flow. If value is

<code class="docutils literal notranslate">freeform</code>, the nodes can freely move on the plane. If

value is <code class="docutils literal notranslate">fixed</code>, the nodes are stationary.</li>

<li>customdata – Assigns extra data each datum. This may be useful when

listening to hover, click and selection events. Note

that, “scatter” traces also appends customdata items in

the markers DOM elements</li>

<li>customdatasrc – Sets the source reference on Chart Studio Cloud for

customdata .</li>

<li>domain – <a class="reference internal" href="plotly.graph_objects.sankey.html#plotly.graph_objects.sankey.Domain" title="plotly.graph_objects.sankey.Domain"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.sankey.Domain</code></a> instance or

dict with compatible properties</li>

<li>hoverinfo – Determines which trace information appear on hover. If

<code class="docutils literal notranslate">none</code> or <code class="docutils literal notranslate">skip</code> are set, no information is displayed

upon hovering. But, if <code class="docutils literal notranslate">none</code> is set, click and hover

events are still fired. Note that this attribute is

superseded by <code class="docutils literal notranslate">node.hoverinfo</code> and <code class="docutils literal notranslate">node.hoverinfo</code> for

nodes and links respectively.</li>

<li>hoverlabel – <a class="reference internal" href="plotly.graph_objects.sankey.html#plotly.graph_objects.sankey.Hoverlabel" title="plotly.graph_objects.sankey.Hoverlabel"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.sankey.Hoverlabel</code></a>

instance or dict with compatible properties</li>

<li>ids – Assigns id labels to each datum. These ids for object

constancy of data points during animation. Should be an

array of strings, not numbers or any other type.</li>

<li>idssrc – Sets the source reference on Chart Studio Cloud for

ids .</li>

<li>link – The links of the Sankey plot.</li>

<li>meta – Assigns extra meta information associated with this

trace that can be used in various text attributes.

Attributes such as trace <code class="docutils literal notranslate">name</code>, graph, axis and

colorbar <code class="docutils literal notranslate">title.text</code>, annotation <code class="docutils literal notranslate">text</code>

<code class="docutils literal notranslate">rangeselector</code>, <code class="docutils literal notranslate">updatemenues</code> and <code class="docutils literal notranslate">sliders</code> <code class="docutils literal notranslate">label</code>

text all support <code class="docutils literal notranslate">meta</code>. To access the trace <code class="docutils literal notranslate">meta</code>

values in an attribute in the same trace, simply use

<code class="docutils literal notranslate">%{meta[i]}</code> where <code class="docutils literal notranslate">i</code> is the index or key of the

<code class="docutils literal notranslate">meta</code> item in question. To access trace <code class="docutils literal notranslate">meta</code> in

layout attributes, use <code class="docutils literal notranslate">%{data[n[.meta[i]}</code> where <code class="docutils literal notranslate">i</code>

is the index or key of the <code class="docutils literal notranslate">meta</code> and <code class="docutils literal notranslate">n</code> is the trace

index.</li>

<li>metasrc – Sets the source reference on Chart Studio Cloud for

meta .</li>

<li>name – Sets the trace name. The trace name appear as the

legend item and on hover.</li>

<li>node – The nodes of the Sankey plot.</li>

<li>orientation – Sets the orientation of the Sankey diagram.</li>

<li>selectedpoints – Array containing integer indices of selected points.

Has an effect only for traces that support selections.

Note that an empty array means an empty selection where

the <code class="docutils literal notranslate">unselected</code> are turned on for all points, whereas,

any other non-array values means no selection all where

the <code class="docutils literal notranslate">selected</code> and <code class="docutils literal notranslate">unselected</code> styles have no effect.</li>

<li>stream – <a class="reference internal" href="plotly.graph_objects.sankey.html#plotly.graph_objects.sankey.Stream" title="plotly.graph_objects.sankey.Stream"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.sankey.Stream</code></a> instance or

dict with compatible properties</li>

<li>textfont – Sets the font for node labels</li>

<li>uid – Assign an id to this trace, Use this to provide object

constancy between traces during animations and

transitions.</li>

<li>uirevision – Controls persistence of some user-driven changes to the

trace: <code class="docutils literal notranslate">constraintrange</code> in <code class="docutils literal notranslate">parcoords</code> traces, as well

as some <code class="docutils literal notranslate">editable: true</code> modifications such as <code class="docutils literal notranslate">name</code>

and <code class="docutils literal notranslate">colorbar.title</code>. Defaults to <code class="docutils literal notranslate">layout.uirevision</code>.

Note that other user-driven trace attribute changes are

controlled by <code class="docutils literal notranslate">layout</code> attributes: <code class="docutils literal notranslate">trace.visible</code> is

controlled by <code class="docutils literal notranslate">layout.legend.uirevision</code>,

<code class="docutils literal notranslate">selectedpoints</code> is controlled by

<code class="docutils literal notranslate">layout.selectionrevision</code>, and <code class="docutils literal notranslate">colorbar.(x|y)</code>

(accessible with <code class="docutils literal notranslate">config: {editable: true}</code>) is

controlled by <code class="docutils literal notranslate">layout.editrevision</code>. Trace changes are

tracked by <code class="docutils literal notranslate">uid</code>, which only falls back on trace index

if no <code class="docutils literal notranslate">uid</code> is provided. So if your app can add/remove

traces before the end of the <code class="docutils literal notranslate">data</code> array, such that

the same trace has a different index, you can still

preserve user-driven changes if you give each trace a

<code class="docutils literal notranslate">uid</code> that stays with it as it moves.</li>

<li>valueformat – Sets the value formatting rule using d3 formatting

mini-language which is similar to those of Python. See

<a class="reference external" href="https://github.com/d3/d3-3.x-api">https://github.com/d3/d3-3.x-api</a>-

reference/blob/master/Formatting.md#d3_format</li>

<li>valuesuffix – Adds a unit to follow the value in the hover tooltip.

Add a space if a separation is necessary from the

value.</li>

<li>visible – Determines whether or not this trace is visible. If

“legendonly”, the trace is not drawn, but can appear as

a legend item (provided that the legend itself is

visible).</li>

</ul>

</dd>

<dt class="field-even">Returns</dt>

</dd>

<dt class="field-odd">Return type</dt>

<dd class="field-odd"><a class="reference internal" href="plotly.graph_objects.html#plotly.graph_objects.Sankey" title="plotly.graph_objects.Sankey">Sankey</a>

</dd>

</dl>

</dd></dl>

</div>

<h1><a class="reference internal" href="plotly.graph_objects.html#module-plotly.graph_objects" title="plotly.graph_objects"><code class="xref py py-mod docutils literal notranslate">plotly.graph_objects</code></a>.sankey<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h1>

</colgroup>

<tbody>

<tr class="row-odd"><td><a class="reference internal" href="#module-plotly.graph_objects.sankey" title="plotly.graph_objects.sankey"><code class="xref py py-obj docutils literal notranslate">plotly.graph_objects.sankey</code></a></td>

</tr>

</tbody>

</table>

</div>

var _gaq = _gaq || [];

_gaq.push(['_setAccount', 'UA-39373211-1']);

_gaq.push(['_setDomainName', 'none']);

_gaq.push(['_setAllowLinker', true]);

_gaq.push(['_trackPageview']);

(function() {

var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;

ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';

var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);

})();

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

plotly.graph_objects.Sankey.html

Latest commit

History

plotly.graph_objects.Sankey.html

File metadata and controls