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

History

367 lines (335 loc) · 31.3 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

<!DOCTYPE html>

<head>

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

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

</ul>

</li>

<li>

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

</a>

</li>

<li>

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

class <code class="sig-prename descclassname">plotly.graph_objects.</code><code class="sig-name descname">Choropleth</code>(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Choropleth" title="Permalink to this definition">¶</a></dt>

<code class="sig-name descname">__init__</code>(arg=None, autocolorscale=None, coloraxis=None, colorbar=None, colorscale=None, customdata=None, customdatasrc=None, featureidkey=None, geo=None, geojson=None, hoverinfo=None, hoverinfosrc=None, hoverlabel=None, hovertemplate=None, hovertemplatesrc=None, hovertext=None, hovertextsrc=None, ids=None, idssrc=None, legendgroup=None, locationmode=None, locations=None, locationssrc=None, marker=None, meta=None, metasrc=None, name=None, reversescale=None, selected=None, selectedpoints=None, showlegend=None, showscale=None, stream=None, text=None, textsrc=None, uid=None, uirevision=None, unselected=None, visible=None, z=None, zauto=None, zmax=None, zmid=None, zmin=None, zsrc=None, **kwargs)<a class="headerlink" href="#plotly.graph_objects.Choropleth.__init__" title="Permalink to this definition">¶</a></dt>

<dd>Construct a new Choropleth object

The data that describes the choropleth value-to-color mapping

is set in <code class="docutils literal notranslate">z</code>. The geographic locations corresponding to each

value in <code class="docutils literal notranslate">z</code> are set in <code class="docutils literal notranslate">locations</code>.

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

<li>autocolorscale – Determines whether the colorscale is a default palette

(<code class="docutils literal notranslate">autocolorscale: true</code>) or the palette determined by

<code class="docutils literal notranslate">colorscale</code>. In case <code class="docutils literal notranslate">colorscale</code> is unspecified or

<code class="docutils literal notranslate">autocolorscale</code> is true, the default palette will be

chosen according to whether numbers in the <code class="docutils literal notranslate">color</code>

array are all positive, all negative or mixed.</li>

<li>coloraxis – Sets a reference to a shared color axis. References to

these shared color axes are “coloraxis”, “coloraxis2”,

“coloraxis3”, etc. Settings for these shared color axes

are set in the layout, under <code class="docutils literal notranslate">layout.coloraxis</code>,

<code class="docutils literal notranslate">layout.coloraxis2</code>, etc. Note that multiple color

scales can be linked to the same color axis.</li>

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

instance or dict with compatible properties</li>

<li>colorscale – Sets the colorscale. The colorscale must be an array

containing arrays mapping a normalized value to an rgb,

rgba, hex, hsl, hsv, or named color string. At minimum,

a mapping for the lowest (0) and highest (1) values are

required. For example, <code class="docutils literal notranslate">[[0, 'rgb(0,0,255)'], [1,

'rgb(255,0,0)']]</code>. To control the bounds of the

colorscale in color space, use`zmin` and <code class="docutils literal notranslate">zmax</code>.

Alternatively, <code class="docutils literal notranslate">colorscale</code> may be a palette name

string of the following list: Greys,YlGnBu,Greens,YlOrR

d,Bluered,RdBu,Reds,Blues,Picnic,Rainbow,Portland,Jet,H

ot,Blackbody,Earth,Electric,Viridis,Cividis.</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>featureidkey – Sets the key in GeoJSON features which is used as id to

match the items included in the <code class="docutils literal notranslate">locations</code> array. Only

has an effect when <code class="docutils literal notranslate">geojson</code> is set. Support nested

property, for example “properties.name”.</li>

<li>geo – Sets a reference between this trace’s geospatial

coordinates and a geographic map. If “geo” (the default

value), the geospatial coordinates refer to

<code class="docutils literal notranslate">layout.geo</code>. If “geo2”, the geospatial coordinates

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

<li>geojson – Sets optional GeoJSON data associated with this trace.

If not given, the features on the base map are used. It

can be set as a valid GeoJSON object or as a URL

string. Note that we only accept GeoJSONs of type

“FeatureCollection” or “Feature” with geometries of

type “Polygon” or “MultiPolygon”.</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.choropleth.html#plotly.graph_objects.choropleth.Hoverlabel" title="plotly.graph_objects.choropleth.Hoverlabel"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.choropleth.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. 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 <code class="docutils literal notranslate"><extra></extra></code>.</li>

<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>locationmode – Determines the set of locations used to match entries

in <code class="docutils literal notranslate">locations</code> to regions on the map. Values “ISO-3”,

“USA-states”, country names correspond to features on

the base map and value “geojson-id” corresponds to

features from a custom GeoJSON linked to the <code class="docutils literal notranslate">geojson</code>

attribute.</li>

<li>locations – Sets the coordinates via location IDs or names. See

<code class="docutils literal notranslate">locationmode</code> for more info.</li>

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

locations .</li>

<li>marker – <a class="reference internal" href="plotly.graph_objects.choropleth.html#plotly.graph_objects.choropleth.Marker" title="plotly.graph_objects.choropleth.Marker"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.choropleth.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>reversescale – Reverses the color mapping if true. If true, <code class="docutils literal notranslate">zmin</code>

will correspond to the last color in the array and

<code class="docutils literal notranslate">zmax</code> will correspond to the first color.</li>

<li>selected – <a class="reference internal" href="plotly.graph_objects.choropleth.html#plotly.graph_objects.choropleth.Selected" title="plotly.graph_objects.choropleth.Selected"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.choropleth.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>showscale – Determines whether or not a colorbar is displayed for

this trace.</li>

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

instance or dict with compatible properties</li>

<li>text – Sets the text elements associated with each location.</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.choropleth.html#plotly.graph_objects.choropleth.Unselected" title="plotly.graph_objects.choropleth.Unselected"><code class="xref py py-class docutils literal notranslate">plotly.graph_objects.choropleth.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>z – Sets the color values.</li>

<li>zauto – Determines whether or not the color domain is computed

with respect to the input data (here in <code class="docutils literal notranslate">z</code>) or the

bounds set in <code class="docutils literal notranslate">zmin</code> and <code class="docutils literal notranslate">zmax</code> Defaults to <code class="docutils literal notranslate">false</code>

when <code class="docutils literal notranslate">zmin</code> and <code class="docutils literal notranslate">zmax</code> are set by the user.</li>

<li>zmax – Sets the upper bound of the color domain. Value should

have the same units as in <code class="docutils literal notranslate">z</code> and if set, <code class="docutils literal notranslate">zmin</code> must

be set as well.</li>

<li>zmid – Sets the mid-point of the color domain by scaling

<code class="docutils literal notranslate">zmin</code> and/or <code class="docutils literal notranslate">zmax</code> to be equidistant to this point.

Value should have the same units as in <code class="docutils literal notranslate">z</code>. Has no

effect when <code class="docutils literal notranslate">zauto</code> is <code class="docutils literal notranslate">false</code>.</li>

<li>zmin – Sets the lower bound of the color domain. Value should

have the same units as in <code class="docutils literal notranslate">z</code> and if set, <code class="docutils literal notranslate">zmax</code> must

be set as well.</li>

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

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

Latest commit

History

plotly.graph_objects.Choropleth.html

File metadata and controls