plotly.py-docs/generated/plotly.basedatatypes.BaseFigure.html at debug · plotly/plotly.py-docs

History

293 lines (261 loc) · 21.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

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

<!DOCTYPE html>

<head>

<title>plotly.basedatatypes.BaseFigure — 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>

<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"><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="#">plotly.basedatatypes.BaseFigure</a></li>

</ul>

</li>

</ul>

</div>

</form>

</div>

<h1>plotly.basedatatypes.BaseFigure<a class="headerlink" href="#plotly-basedatatypes-basefigure" title="Permalink to this headline">¶</a></h1>

class <code class="sig-prename descclassname">plotly.basedatatypes.</code><code class="sig-name descname">BaseFigure</code>(data=None, layout_plotly=None, frames=None, skip_invalid=False, **kwargs)<a class="headerlink" href="#plotly.basedatatypes.BaseFigure" title="Permalink to this definition">¶</a></dt>

<dd>Base class for all figure types (both widget and non-widget)

<code class="sig-name descname">__init__</code>(data=None, layout_plotly=None, frames=None, skip_invalid=False, **kwargs)<a class="headerlink" href="#plotly.basedatatypes.BaseFigure.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a BaseFigure object

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

<li>data – One of:

- A list or tuple of trace objects (or dicts that can be coerced

into trace objects)

<ul>

<li>If <code class="docutils literal notranslate">data</code> is a dict that contains a ‘data’,</li>

</ul>

’layout’, or ‘frames’ key then these values are used to

construct the figure.

<ul>

<li>If <code class="docutils literal notranslate">data</code> is a <code class="docutils literal notranslate">BaseFigure</code> instance then the <code class="docutils literal notranslate">data</code>, <code class="docutils literal notranslate">layout</code>,</li>

</ul>

and <code class="docutils literal notranslate">frames</code> properties are extracted from the input figure

</li>

<li>layout_plotly – The plotly layout dict.

Note: this property is named <code class="docutils literal notranslate">layout_plotly</code> rather than <code class="docutils literal notranslate">layout</code>

to deconflict it with the <code class="docutils literal notranslate">layout</code> constructor parameter of the

<code class="docutils literal notranslate">widgets.DOMWidget</code> ipywidgets class, as the <code class="docutils literal notranslate">BaseFigureWidget</code>

class is a subclass of both BaseFigure and widgets.DOMWidget.

If the <code class="docutils literal notranslate">data</code> property is a BaseFigure instance, or a dict that

contains a ‘layout’ key, then this property is ignored.

</li>

<li>frames – A list or tuple of <code class="docutils literal notranslate">plotly.graph_objects.Frame</code> objects (or dicts

that can be coerced into Frame objects)

If the <code class="docutils literal notranslate">data</code> property is a BaseFigure instance, or a dict that

contains a ‘frames’ key, then this property is ignored.

</li>

<li>skip_invalid (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.8)">bool</a>) – If True, invalid properties in the figure specification will be

skipped silently. If False (default) invalid properties in the

figure specification will result in a ValueError</li>

</ul>

</dd>

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

<dd class="field-even"><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#ValueError" title="(in Python v3.8)">ValueError</a> – if a property in the specification of data, layout, or frames

is invalid AND skip_invalid is False

</dd>

</dl>

</dd></dl>

Methods

</colgroup>

<tbody>

<tr class="row-odd"><td><a class="reference internal" href="#plotly.basedatatypes.BaseFigure.__init__" title="plotly.basedatatypes.BaseFigure.__init__"><code class="xref py py-obj docutils literal notranslate">__init__</code></a>([data, layout_plotly, frames, …])</td>

<td>Construct a BaseFigure object</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.add_trace" title="plotly.basedatatypes.BaseFigure.add_trace"><code class="xref py py-obj docutils literal notranslate">add_trace</code></a>(trace[, row, col, secondary_y])</td>

<td>Add a trace to the figure</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.add_traces" title="plotly.basedatatypes.BaseFigure.add_traces"><code class="xref py py-obj docutils literal notranslate">add_traces</code></a>(data[, rows, cols, secondary_ys])</td>

<td>Add traces to the figure</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.append_trace" title="plotly.basedatatypes.BaseFigure.append_trace"><code class="xref py py-obj docutils literal notranslate">append_trace</code></a>(trace, row, col)</td>

<td>Add a trace to the figure bound to axes at the specified row, col index.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.batch_animate" title="plotly.basedatatypes.BaseFigure.batch_animate"><code class="xref py py-obj docutils literal notranslate">batch_animate</code></a>([duration, easing])</td>

<td>Context manager to animate trace / layout updates</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.batch_update" title="plotly.basedatatypes.BaseFigure.batch_update"><code class="xref py py-obj docutils literal notranslate">batch_update</code></a>()</td>

<td>A context manager that batches up trace and layout assignment operations into a singe plotly_update message that is executed when the context exits.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.for_each_trace" title="plotly.basedatatypes.BaseFigure.for_each_trace"><code class="xref py py-obj docutils literal notranslate">for_each_trace</code></a>(fn[, selector, row, col, …])</td>

<td>Apply a function to all traces that satisfy the specified selection criteria</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.get_subplot" title="plotly.basedatatypes.BaseFigure.get_subplot"><code class="xref py py-obj docutils literal notranslate">get_subplot</code></a>(row, col[, secondary_y])</td>

<td>Return an object representing the subplot at the specified row and column.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.plotly_relayout" title="plotly.basedatatypes.BaseFigure.plotly_relayout"><code class="xref py py-obj docutils literal notranslate">plotly_relayout</code></a>(relayout_data, **kwargs)</td>

<td>Perform a Plotly relayout operation on the figure’s layout</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.plotly_restyle" title="plotly.basedatatypes.BaseFigure.plotly_restyle"><code class="xref py py-obj docutils literal notranslate">plotly_restyle</code></a>(restyle_data[, trace_indexes])</td>

<td>Perform a Plotly restyle operation on the figure’s traces</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.plotly_update" title="plotly.basedatatypes.BaseFigure.plotly_update"><code class="xref py py-obj docutils literal notranslate">plotly_update</code></a>([restyle_data, relayout_data, …])</td>

<td>Perform a Plotly update operation on the figure.</td>

</tr>

<td>Remove the value associated with the specified key and return it</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.print_grid" title="plotly.basedatatypes.BaseFigure.print_grid"><code class="xref py py-obj docutils literal notranslate">print_grid</code></a>()</td>

<td>Print a visual layout of the figure’s axes arrangement.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.select_traces" title="plotly.basedatatypes.BaseFigure.select_traces"><code class="xref py py-obj docutils literal notranslate">select_traces</code></a>([selector, row, col, secondary_y])</td>

<td>Select traces from a particular subplot cell and/or traces that satisfy custom selection criteria.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.show" title="plotly.basedatatypes.BaseFigure.show"><code class="xref py py-obj docutils literal notranslate">show</code></a>(*args, **kwargs)</td>

<td>Show a figure using either the default renderer(s) or the renderer(s) specified by the renderer argument</td>

</tr>

<td>Convert figure to a dictionary</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.to_html" title="plotly.basedatatypes.BaseFigure.to_html"><code class="xref py py-obj docutils literal notranslate">to_html</code></a>(*args, **kwargs)</td>

<td>Convert a figure to an HTML string representation.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.to_image" title="plotly.basedatatypes.BaseFigure.to_image"><code class="xref py py-obj docutils literal notranslate">to_image</code></a>(*args, **kwargs)</td>

<td>Convert a figure to a static image bytes string</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.to_json" title="plotly.basedatatypes.BaseFigure.to_json"><code class="xref py py-obj docutils literal notranslate">to_json</code></a>(*args, **kwargs)</td>

<td>Convert a figure to a JSON string representation</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.to_ordered_dict" title="plotly.basedatatypes.BaseFigure.to_ordered_dict"><code class="xref py py-obj docutils literal notranslate">to_ordered_dict</code></a>([skip_uid])</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.to_plotly_json" title="plotly.basedatatypes.BaseFigure.to_plotly_json"><code class="xref py py-obj docutils literal notranslate">to_plotly_json</code></a>()</td>

<td>Convert figure to a JSON representation as a Python dict</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.update" title="plotly.basedatatypes.BaseFigure.update"><code class="xref py py-obj docutils literal notranslate">update</code></a>([dict1, overwrite])</td>

<td>Update the properties of the figure with a dict and/or with keyword arguments.</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.update_layout" title="plotly.basedatatypes.BaseFigure.update_layout"><code class="xref py py-obj docutils literal notranslate">update_layout</code></a>([dict1, overwrite])</td>

<td>Update the properties of the figure’s layout with a dict and/or with keyword arguments.</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.update_traces" title="plotly.basedatatypes.BaseFigure.update_traces"><code class="xref py py-obj docutils literal notranslate">update_traces</code></a>([patch, selector, row, col, …])</td>

<td>Perform a property update operation on all traces that satisfy the specified selection criteria</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.write_html" title="plotly.basedatatypes.BaseFigure.write_html"><code class="xref py py-obj docutils literal notranslate">write_html</code></a>(*args, **kwargs)</td>

<td>Write a figure to an HTML file representation</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.write_image" title="plotly.basedatatypes.BaseFigure.write_image"><code class="xref py py-obj docutils literal notranslate">write_image</code></a>(*args, **kwargs)</td>

<td>Convert a figure to a static image and write it to a file or writeable object</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.write_json" title="plotly.basedatatypes.BaseFigure.write_json"><code class="xref py py-obj docutils literal notranslate">write_json</code></a>(*args, **kwargs)</td>

<td>Convert a figure to JSON and write it to a file or writeable object</td>

</tr>

</tbody>

</table>

Attributes

</colgroup>

<tbody>

<td>The <code class="docutils literal notranslate">data</code> property is a tuple of the figure’s trace objects</td>

</tr>

<tr class="row-even"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.frames" title="plotly.basedatatypes.BaseFigure.frames"><code class="xref py py-obj docutils literal notranslate">frames</code></a></td>

<td>The <code class="docutils literal notranslate">frames</code> property is a tuple of the figure’s frame objects</td>

</tr>

<tr class="row-odd"><td><a class="reference internal" href="plotly.html#plotly.basedatatypes.BaseFigure.layout" title="plotly.basedatatypes.BaseFigure.layout"><code class="xref py py-obj docutils literal notranslate">layout</code></a></td>

<td>The <code class="docutils literal notranslate">layout</code> property of the figure</td>

</tr>

</tbody>

</table>

</dd></dl>

</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.basedatatypes.BaseFigure.html

Latest commit

History

plotly.basedatatypes.BaseFigure.html

File metadata and controls