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

History

389 lines (357 loc) · 33.1 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

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

<!DOCTYPE html>

<head>

<title>plotly.graph_objects.Histogram — 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>.Histogram</a></li>

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

</ul>

</li>

<li>

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

</a>

</li>

<li>

<a href="plotly.graph_objects.Histogram2d.html" title="Next Chapter: plotly.graph_objects.Histogram2d">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>.Histogram<a class="headerlink" href="#plotly-graph-objs-histogram" title="Permalink to this headline">¶</a></h1>

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Histogram</code>(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ysrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Histogram" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, alignmentgroup=None, autobinx=None, autobiny=None, bingroup=None, cumulative=None, customdata=None, customdatasrc=None, error_x=None, error_y=None, histfunc=None, histnorm=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, marker=None, meta=None, metasrc=None, name=None, nbinsx=None, nbinsy=None, offsetgroup=None, opacity=None, orientation=None, selected=None, selectedpoints=None, showlegend=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, x=None, xaxis=None, xbins=None, xcalendar=None, xsrc=None, y=None, yaxis=None, ybins=None, ycalendar=None, ysrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Histogram.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Histogram object

The sample data from which statistics are computed is set in

<code class="docutils literal notranslate">x</code> for vertically spanning histograms and in <code class="docutils literal notranslate">y</code> for

horizontally spanning histograms. Binning options are set

<code class="docutils literal notranslate">xbins</code> and <code class="docutils literal notranslate">ybins</code> respectively if no aggregation data is

provided.

<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.Histogram" title="plotly.graph_objects.Histogram"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.Histogram</code></a></li>

<li>alignmentgroup – Set several traces linked to the same position axis or

matching axes to the same alignmentgroup. This controls

whether bars compute their positional range dependently

or independently.</li>

<li>autobinx – Obsolete: since v1.42 each bin attribute is auto-

determined separately and <code class="docutils literal notranslate">autobinx</code> is not needed.

However, we accept <code class="docutils literal notranslate">autobinx: true</code> or <code class="docutils literal notranslate">false</code> and will

update <code class="docutils literal notranslate">xbins</code> accordingly before deleting <code class="docutils literal notranslate">autobinx</code>

from the trace.</li>

<li>autobiny – Obsolete: since v1.42 each bin attribute is auto-

determined separately and <code class="docutils literal notranslate">autobiny</code> is not needed.

However, we accept <code class="docutils literal notranslate">autobiny: true</code> or <code class="docutils literal notranslate">false</code> and will

update <code class="docutils literal notranslate">ybins</code> accordingly before deleting <code class="docutils literal notranslate">autobiny</code>

from the trace.</li>

<li>bingroup – Set a group of histogram traces which will have

compatible bin settings. Note that traces on the same

subplot and with the same “orientation” under <code class="docutils literal notranslate">barmode</code>

“stack”, “relative” and “group” are forced into the

same bingroup, Using <code class="docutils literal notranslate">bingroup</code>, traces under <code class="docutils literal notranslate">barmode</code>

“overlay” and on different axes (of the same axis type)

can have compatible bin settings. Note that histogram

and histogram2d* trace can share the same <code class="docutils literal notranslate">bingroup</code></li>

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

instance or dict with compatible properties</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>error_x – <a class="reference internal" href="plotly.graph_objects.histogram.html#plotly.graph_objects.histogram.ErrorX" title="plotly.graph_objects.histogram.ErrorX"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.histogram.ErrorX</code></a> instance

or dict with compatible properties</li>

<li>error_y – <a class="reference internal" href="plotly.graph_objects.histogram.html#plotly.graph_objects.histogram.ErrorY" title="plotly.graph_objects.histogram.ErrorY"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.histogram.ErrorY</code></a> instance

or dict with compatible properties</li>

<li>histfunc – Specifies the binning function used for this histogram

trace. If “count”, the histogram values are computed by

counting the number of values lying inside each bin. If

“sum”, “avg”, “min”, “max”, the histogram values are

computed using the sum, the average, the minimum or the

maximum of the values lying inside each bin

respectively.</li>

<li>histnorm – Specifies the type of normalization used for this

histogram trace. If “”, the span of each bar

corresponds to the number of occurrences (i.e. the

number of data points lying inside the bins). If

“percent” / “probability”, the span of each bar

corresponds to the percentage / fraction of occurrences

with respect to the total number of sample points

(here, the sum of all bin HEIGHTS equals 100% / 1). If

“density”, the span of each bar corresponds to the

number of occurrences in a bin divided by the size of

the bin interval (here, the sum of all bin AREAS equals

the total number of sample points). If probability

density, the area of each bar corresponds to the

probability that an event will fall into the

corresponding bin (here, the sum of all bin AREAS

equals 1).</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.</li>

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

hoverinfo .</li>

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

instance or dict with compatible properties</li>

<li>hovertemplate – Template string used for rendering the information that

appear on hover box. Note that this will override

<code class="docutils literal notranslate">hoverinfo</code>. Variables are inserted using %{variable},

for example “y: %{y}”. Numbers are formatted using

d3-format’s syntax %{variable:d3-format}, for example

“Price: %{y:$.2f}”. https://github.com/d3/d3-3.x-api-

reference/blob/master/Formatting.md#d3_format for

details on the formatting syntax. Dates are formatted

using d3-time-format’s syntax %{variable|d3-time-

format}, for example “Day: %{2019-01-01|%A}”.

https://github.com/d3/d3-3.x-api-

reference/blob/master/Time-Formatting.md#format for

details on the date formatting syntax. The variables

available in <code class="docutils literal notranslate">hovertemplate</code> are the ones emitted as

event data described at this link

<a class="reference external" href="https://plotly.com/javascript/plotlyjs-events/#event">https://plotly.com/javascript/plotlyjs-events/#event</a>-

data. Additionally, every attributes that can be

specified per-point (the ones that are <code class="docutils literal notranslate">arrayOk: true</code>)

are available. variable <code class="docutils literal notranslate">binNumber</code> Anything contained

in tag <code class="docutils literal notranslate"><extra></code> is displayed in the secondary box, for

example “<extra>{fullData.name}</extra>”. To hide the

secondary box completely, use an empty tag

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

hovertemplate .</li>

<li>hovertext – Same as <code class="docutils literal notranslate">text</code>.</li>

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

hovertext .</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>legendgroup – Sets the legend group for this trace. Traces part of

the same legend group hide/show at the same time when

toggling legend items.</li>

<li>marker – <a class="reference internal" href="plotly.graph_objects.histogram.html#plotly.graph_objects.histogram.Marker" title="plotly.graph_objects.histogram.Marker"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.histogram.Marker</code></a> instance

or dict with compatible properties</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>nbinsx – Specifies the maximum number of desired bins. This

value will be used in an algorithm that will decide the

optimal bin size such that the histogram best

visualizes the distribution of the data. Ignored if

<code class="docutils literal notranslate">xbins.size</code> is provided.</li>

<li>nbinsy – Specifies the maximum number of desired bins. This

value will be used in an algorithm that will decide the

optimal bin size such that the histogram best

visualizes the distribution of the data. Ignored if

<code class="docutils literal notranslate">ybins.size</code> is provided.</li>

<li>offsetgroup – Set several traces linked to the same position axis or

matching axes to the same offsetgroup where bars of the

same position coordinate will line up.</li>

<li>opacity – Sets the opacity of the trace.</li>

<li>orientation – Sets the orientation of the bars. With “v” (“h”), the

value of the each bar spans along the vertical

(horizontal).</li>

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

instance or dict with compatible properties</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>showlegend – Determines whether or not an item corresponding to this

trace is shown in the legend.</li>

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

or dict with compatible properties</li>

<li>text – Sets hover text elements associated with each bar. If a

single string, the same string appears over all bars.

If an array of string, the items are mapped in order to

the this trace’s coordinates.</li>

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

text .</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>unselected – <a class="reference internal" href="plotly.graph_objects.histogram.html#plotly.graph_objects.histogram.Unselected" title="plotly.graph_objects.histogram.Unselected"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.histogram.Unselected</code></a>

instance or dict with compatible properties</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>

<li>x – Sets the sample data to be binned on the x axis.</li>

<li>xaxis – Sets a reference between this trace’s x coordinates and

a 2D cartesian x axis. If “x” (the default value), the

x coordinates refer to <code class="docutils literal notranslate">layout.xaxis</code>. If “x2”, the x

coordinates refer to <code class="docutils literal notranslate">layout.xaxis2</code>, and so on.</li>

<li>xbins – <a class="reference internal" href="plotly.graph_objects.histogram.html#plotly.graph_objects.histogram.XBins" title="plotly.graph_objects.histogram.XBins"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.histogram.XBins</code></a> instance

or dict with compatible properties</li>

<li>xcalendar – Sets the calendar system to use with <code class="docutils literal notranslate">x</code> date data.</li>

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

.</li>

<li>y – Sets the sample data to be binned on the y axis.</li>

<li>yaxis – Sets a reference between this trace’s y coordinates and

a 2D cartesian y axis. If “y” (the default value), the

y coordinates refer to <code class="docutils literal notranslate">layout.yaxis</code>. If “y2”, the y

coordinates refer to <code class="docutils literal notranslate">layout.yaxis2</code>, and so on.</li>

<li>ybins – <a class="reference internal" href="plotly.graph_objects.histogram.html#plotly.graph_objects.histogram.YBins" title="plotly.graph_objects.histogram.YBins"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.histogram.YBins</code></a> instance

or dict with compatible properties</li>

<li>ycalendar – Sets the calendar system to use with <code class="docutils literal notranslate">y</code> date data.</li>

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

.</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.Histogram" title="plotly.graph_objects.Histogram">Histogram</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>.histogram<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.histogram" title="plotly.graph_objects.histogram"><code class="xref py py-obj docutils literal notranslate">plotly.graph_objects.histogram</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.Histogram.html

Latest commit

History

plotly.graph_objects.Histogram.html

File metadata and controls